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/status.h | |
| parent | dedf8b645ad676e7947c83f320198d43f4341570 (diff) | |
| download | zix-8feafa8f00d304a936d926246c29fc48d92535e7.tar.gz zix-8feafa8f00d304a936d926246c29fc48d92535e7.tar.bz2 zix-8feafa8f00d304a936d926246c29fc48d92535e7.zip | |
Improve documentation
Diffstat (limited to 'include/zix/status.h')
| -rw-r--r-- | include/zix/status.h | 7 |
1 files changed, 6 insertions, 1 deletions
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); |