diff options
Diffstat (limited to 'include/zix/common.h')
| -rw-r--r-- | include/zix/common.h | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/include/zix/common.h b/include/zix/common.h index 59a61ac..5a71be5 100644 --- a/include/zix/common.h +++ b/include/zix/common.h @@ -1,4 +1,4 @@ -// Copyright 2016-2020 David Robillard <d@drobilla.net> +// Copyright 2016-2022 David Robillard <d@drobilla.net> // SPDX-License-Identifier: ISC #ifndef ZIX_COMMON_H @@ -9,7 +9,7 @@ #include <stdbool.h> /** - @addtogroup zix + @defgroup zix Zix C API @{ */ @@ -17,19 +17,20 @@ extern "C" { #endif +/// A status code returned by functions typedef enum { - ZIX_STATUS_SUCCESS, - ZIX_STATUS_ERROR, - ZIX_STATUS_NO_MEM, - ZIX_STATUS_NOT_FOUND, - ZIX_STATUS_EXISTS, - ZIX_STATUS_BAD_ARG, - ZIX_STATUS_BAD_PERMS, - ZIX_STATUS_REACHED_END, - ZIX_STATUS_TIMEOUT, - ZIX_STATUS_OVERFLOW, - ZIX_STATUS_NOT_SUPPORTED, - ZIX_STATUS_UNAVAILABLE, + ZIX_STATUS_SUCCESS, ///< Success + ZIX_STATUS_ERROR, ///< Unknown error + ZIX_STATUS_NO_MEM, ///< Out of memory + ZIX_STATUS_NOT_FOUND, ///< Not found + ZIX_STATUS_EXISTS, ///< Exists + ZIX_STATUS_BAD_ARG, ///< Bad argument + ZIX_STATUS_BAD_PERMS, ///< Bad permissions + ZIX_STATUS_REACHED_END, ///< Reached end + ZIX_STATUS_TIMEOUT, ///< Timeout + ZIX_STATUS_OVERFLOW, ///< Overflow + ZIX_STATUS_NOT_SUPPORTED, ///< Not supported + ZIX_STATUS_UNAVAILABLE, ///< Resource unavailable } ZixStatus; /// Return a string describing a status code |