Website Summary Files Commits Branches @commit @diff @stats
path: root / src / Services / StatusCode.h
diff options
context:
space:
mode:
Commitb3d493796c97178f597ecf97e7c1ae46e566fe9c (patch)
Author
 Syndamia <kamen.d.mladenov@protonmail.com>
2022-05-08 21:24:07 +0300
Committer
 Syndamia <kamen.d.mladenov@protonmail.com>
2022-05-08 21:24:07 +0300
Filescd7364f8d9f6e8ed7da87363e5e04c47ca02e8b1 /src/Services/StatusCode.h
FMI-OOP-P1_TicketSystem-b3d493796c97178f597ecf97e7c1ae46e566fe9c.tar
FMI-OOP-P1_TicketSystem-b3d493796c97178f597ecf97e7c1ae46e566fe9c.tar.gz
FMI-OOP-P1_TicketSystem-b3d493796c97178f597ecf97e7c1ae46e566fe9c.zip
Parentbf7689ba06764b72a6212549a5c8a39e294cceee (diff)
Fully documented everything in Services
1 files changed, 10 insertions, 0 deletions
-rw-r--r--src/Services/StatusCode.h10
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,