c8d81ba3bb
All checks were successful
Build / Build (push) Successful in 39s
This commit significantly enhances the `README.md` file, providing comprehensive documentation for the ArmaDragonflyClient. Key changes: * **Detailed Function Categories:** Categorized functions for better organization (Core, Basic Data Operations, Hash Operations, List Operations). * **Usage Examples:** Added clear and concise usage examples for basic operations, hash operations (context and ID-specific), and list operations. * **Function Documentation Structure:** Outlined the structure for individual function documentation. * **License Information:** Updated the license information.
39 lines
2.3 KiB
TeX
39 lines
2.3 KiB
TeX
\doxysection{G\+:/ids/dragonfly/docs/list Directory Reference}
|
|
\hypertarget{dir_72c6efb7383bf0530aa073c1e7428252}{}\label{dir_72c6efb7383bf0530aa073c1e7428252}\index{G:/ids/dragonfly/docs/list Directory Reference@{G:/ids/dragonfly/docs/list Directory Reference}}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This section contains documentation for the list operations of Arma\+Dragonfly\+Client that allow for working with ordered collections of items.\hypertarget{README.md_autotoc_md341}{}\doxysubsection{\texorpdfstring{Available Functions}{Available Functions}}\label{README.md_autotoc_md341}
|
|
|
|
\begin{DoxyItemize}
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2list_2list_add}{list\+Add}{0} -\/ Add an item to a list
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2list_2list_get}{list\+Get}{0} -\/ Get items from a list
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2list_2list_load}{list\+Load}{0} -\/ Load a list from the database
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2list_2list_remove}{list\+Remove}{0} -\/ Remove an item from a list
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2list_2list_set}{list\+Set}{0} -\/ Set an item in a list
|
|
\end{DoxyItemize}\hypertarget{README.md_autotoc_md342}{}\doxysubsection{\texorpdfstring{Example Usage}{Example Usage}}\label{README.md_autotoc_md342}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{//\ Add\ an\ item\ to\ a\ list}
|
|
\DoxyCodeLine{["{}myList"{},\ ["{}myItem"{}]]\ call\ dragonfly\_db\_fnc\_listAdd;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Set\ an\ item\ at\ a\ specific\ index}
|
|
\DoxyCodeLine{["{}myList"{},\ 0,\ [myNewValue]]\ call\ dragonfly\_db\_fnc\_listSet;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Get\ an\ item\ at\ a\ specific\ index}
|
|
\DoxyCodeLine{["{}myList"{},\ 0,\ "{}myFunction"{}]\ call\ dragonfly\_db\_fnc\_listGet;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Load\ all\ items\ from\ a\ list}
|
|
\DoxyCodeLine{["{}myList"{},\ "{}myFunction"{}]\ call\ dragonfly\_db\_fnc\_listLoad;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Remove\ an\ item\ at\ a\ specific\ index}
|
|
\DoxyCodeLine{["{}myList"{},\ 0]\ call\ dragonfly\_db\_fnc\_listRemove;}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{README.md_autotoc_md343}{}\doxysubsection{\texorpdfstring{Related Categories}{Related Categories}}\label{README.md_autotoc_md343}
|
|
|
|
\begin{DoxyItemize}
|
|
\item Core Functions
|
|
\item Basic Data Operations
|
|
\item Hash Operations
|
|
\end{DoxyItemize} |