From 8feafa8f00d304a936d926246c29fc48d92535e7 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Wed, 2 Nov 2022 18:45:53 -0400 Subject: Improve documentation --- include/zix/status.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'include/zix/status.h') 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); -- cgit v1.2.1