From b3d493796c97178f597ecf97e7c1ae46e566fe9c Mon Sep 17 00:00:00 2001 From: Syndamia Date: Sun, 8 May 2022 21:24:07 +0300 Subject: Fully documented everything in Services --- src/Services/StatusCode.h | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'src/Services/StatusCode.h') 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, -- cgit v1.3.1-26-gb76a