diff options
1 files changed, 10 insertions, 0 deletions
| -rw-r--r-- | src/Services/StatusCode.h | 10 |
diff --git a/src/Services/StatusCode.h b/src/Services/StatusCode.h index c09e4f9..3813e87 100644 --- a/src/Services/StatusCode.h +++ b/src/Services/StatusCode.h @@ -1,6 +1,16 @@ #ifndef HEADER_SERVICES_STATUSCODE #define HEADER_SERVICES_STATUSCODE +/*! \file StatusCode.h + * \brief Stores declaration of enum StatusCode + */ + +/*! \brief Used for communication between Services and what uses them + * + * Most functions in Services return a StatusCode. + * + * Those starting with W should be considered Warning, and those starting with E should be considered Errors. + */ enum StatusCode { Success, |