From 35831ff8dc30c9884a7c3340414f005a0d4ada10 Mon Sep 17 00:00:00 2001 From: Syndamia Date: Thu, 12 May 2022 20:21:09 +0300 Subject: Completely reworked documentation --- docs/latex/StatusCode_8h.tex | 46 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/latex/StatusCode_8h.tex (limited to 'docs/latex/StatusCode_8h.tex') diff --git a/docs/latex/StatusCode_8h.tex b/docs/latex/StatusCode_8h.tex new file mode 100644 index 0000000..4d61d13 --- /dev/null +++ b/docs/latex/StatusCode_8h.tex @@ -0,0 +1,46 @@ +\hypertarget{StatusCode_8h}{}\doxysection{src/\+Services/\+Status\+Code.h File Reference} +\label{StatusCode_8h}\index{src/Services/StatusCode.h@{src/Services/StatusCode.h}} + + +Stores declaration of enum Status\+Code. + + +\doxysubsection*{Enumerations} +\begin{DoxyCompactItemize} +\item +enum \mbox{\hyperlink{StatusCode_8h_ae98a46f4ea1a43ca48acaf15d2eb7113}{Status\+Code}} \{ \newline +{\bfseries Success} +, {\bfseries W\+\_\+\+Ticket\+Had\+Not\+Been\+Reserved} +, {\bfseries E\+\_\+\+File\+Could\+Not\+Be\+Opened} +, {\bfseries E\+\_\+\+Hall\+Doesnt\+Exist} +, \newline +{\bfseries E\+\_\+\+Event\+Will\+Overlap} +, {\bfseries E\+\_\+\+Event\+Does\+Not\+Exist} +, {\bfseries E\+\_\+\+Ticket\+Already\+Bought} +, {\bfseries E\+\_\+\+Ticket\+Already\+Reserved} +, \newline +{\bfseries E\+\_\+\+Reservation\+Does\+Not\+Exist} +, {\bfseries E\+\_\+\+Wrong\+Reservation\+Password} + \} +\begin{DoxyCompactList}\small\item\em Used for communication between Services and what uses them. \end{DoxyCompactList}\end{DoxyCompactItemize} + + +\doxysubsection{Detailed Description} +Stores declaration of enum Status\+Code. + + + +\doxysubsection{Enumeration Type Documentation} +\mbox{\Hypertarget{StatusCode_8h_ae98a46f4ea1a43ca48acaf15d2eb7113}\label{StatusCode_8h_ae98a46f4ea1a43ca48acaf15d2eb7113}} +\index{StatusCode.h@{StatusCode.h}!StatusCode@{StatusCode}} +\index{StatusCode@{StatusCode}!StatusCode.h@{StatusCode.h}} +\doxysubsubsection{\texorpdfstring{StatusCode}{StatusCode}} +{\footnotesize\ttfamily enum \mbox{\hyperlink{StatusCode_8h_ae98a46f4ea1a43ca48acaf15d2eb7113}{Status\+Code}}} + + + +Used for communication between Services and what uses them. + +Most functions in Services return a Status\+Code. + +Those starting with W should be considered Warning, and those starting with E should be considered Errors. \ No newline at end of file -- cgit v1.3.1-26-gb76a