From c49208d2d88ac198640e7d4cb4155da57d96da13 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Wed, 11 Sep 2019 22:43:19 -0500 Subject: [PATCH] Cleanup: document f_status --- level_0/f_status/c/status.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/level_0/f_status/c/status.h b/level_0/f_status/c/status.h index 5420626..4ae60c1 100644 --- a/level_0/f_status/c/status.h +++ b/level_0/f_status/c/status.h @@ -19,6 +19,9 @@ extern "C" { #endif +/** + * Status masks. + */ #ifndef _di_f_status_masks_ // f_status is required to be exactly 16 bits, the first two high order bits represent error and warning respectively. #define f_status_bit_error 0x8000 // 1000 0000 0000 0000 @@ -46,7 +49,11 @@ extern "C" { #define f_status_set_fine(status) (status & f_status_mask_fine) #endif // _di_f_status_masks_ -// use of an enumerator makes more sense here than explicitly defining every error code (or return code). +/** + * All standard/core status codes. + * + * The code f_last_status_code is intended to be used as the starting point for anything extending this and povided its own status codes. + */ enum { #ifndef _di_f_status_booleans_ f_false = 0, -- 1.8.3.1