diff options
| author | David Robillard <d@drobilla.net> | 2022-11-02 18:45:53 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2022-11-02 18:45:53 -0400 |
| commit | 8feafa8f00d304a936d926246c29fc48d92535e7 (patch) | |
| tree | c136554a95b1ff999e416e42c74a42aa0ef46ed9 /include/zix | |
| parent | dedf8b645ad676e7947c83f320198d43f4341570 (diff) | |
| download | zix-8feafa8f00d304a936d926246c29fc48d92535e7.tar.gz zix-8feafa8f00d304a936d926246c29fc48d92535e7.tar.bz2 zix-8feafa8f00d304a936d926246c29fc48d92535e7.zip | |
Improve documentation
Diffstat (limited to 'include/zix')
| -rw-r--r-- | include/zix/digest.h | 2 | ||||
| -rw-r--r-- | include/zix/status.h | 7 | ||||
| -rw-r--r-- | include/zix/zix.h | 9 |
3 files changed, 15 insertions, 3 deletions
diff --git a/include/zix/digest.h b/include/zix/digest.h index 4c4fb02..deffaf0 100644 --- a/include/zix/digest.h +++ b/include/zix/digest.h @@ -13,7 +13,7 @@ ZIX_BEGIN_DECLS /** @defgroup zix_digest Digest - @ingroup zix_utilities + @ingroup zix_algorithms Functions to generate a short "digest" of data with minimal collisions. diff --git a/include/zix/status.h b/include/zix/status.h index dfd6412..47aede8 100644 --- a/include/zix/status.h +++ b/include/zix/status.h @@ -32,7 +32,12 @@ typedef enum { ZIX_STATUS_MAX_LINKS, ///< Too many links } ZixStatus; -/// Return a string describing a status code +/** + Return a string describing a status code in plain English. + + The returned string is always one sentence, with an uppercase first + character, and no trailing period. +*/ ZIX_CONST_API const char* zix_strerror(ZixStatus status); diff --git a/include/zix/zix.h b/include/zix/zix.h index db54ce4..d0ac943 100644 --- a/include/zix/zix.h +++ b/include/zix/zix.h @@ -17,7 +17,6 @@ */ #include "zix/attributes.h" -#include "zix/digest.h" #include "zix/status.h" #include "zix/string_view.h" @@ -32,6 +31,14 @@ /** @} + @defgroup zix_algorithms Algorithms + @{ +*/ + +#include "zix/digest.h" + +/** + @} @defgroup zix_data_structures Data Structures @{ */ |