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.
36 lines
2.0 KiB
TeX
36 lines
2.0 KiB
TeX
\doxysection{G\+:/ids/dragonfly/docs/basic Directory Reference}
|
|
\hypertarget{dir_71f12be5768ca2af9c9f300d019944af}{}\label{dir_71f12be5768ca2af9c9f300d019944af}\index{G:/ids/dragonfly/docs/basic Directory Reference@{G:/ids/dragonfly/docs/basic Directory Reference}}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This section contains documentation for the basic data operations of Arma\+Dragonfly\+Client that allow for simple key-\/value storage and retrieval.\hypertarget{README.md_autotoc_md37}{}\doxysubsection{\texorpdfstring{Available Functions}{Available Functions}}\label{README.md_autotoc_md37}
|
|
|
|
\begin{DoxyItemize}
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2basic_2delete}{delete}{0} -\/ Delete a value from the database
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2basic_2fetch}{fetch}{0} -\/ Fetch a value from the database
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2basic_2get}{get}{0} -\/ Get a value from the database
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2basic_2save}{save}{0} -\/ Save the database to disk
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2basic_2set}{set}{0} -\/ Set a value in the database
|
|
\end{DoxyItemize}\hypertarget{README.md_autotoc_md38}{}\doxysubsection{\texorpdfstring{Example Usage}{Example Usage}}\label{README.md_autotoc_md38}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{//\ Set\ a\ value}
|
|
\DoxyCodeLine{["{}myKey"{},\ [myValue]]\ call\ dragonfly\_db\_fnc\_set;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Get\ a\ value}
|
|
\DoxyCodeLine{["{}myKey"{},\ "{}myFunction"{}]\ call\ dragonfly\_db\_fnc\_get;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Delete\ a\ key}
|
|
\DoxyCodeLine{["{}myKey"{}]\ call\ dragonfly\_db\_fnc\_delete;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Save\ database\ to\ disk}
|
|
\DoxyCodeLine{[]\ call\ dragonfly\_db\_fnc\_save;}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{README.md_autotoc_md39}{}\doxysubsection{\texorpdfstring{Related Categories}{Related Categories}}\label{README.md_autotoc_md39}
|
|
|
|
\begin{DoxyItemize}
|
|
\item Core Functions
|
|
\item Hash Operations
|
|
\item List Operations
|
|
\end{DoxyItemize} |