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.
32 lines
2.0 KiB
TeX
32 lines
2.0 KiB
TeX
\doxysection{G\+:/ids/dragonfly/docs/core Directory Reference}
|
|
\hypertarget{dir_10eb6422e80bd721a9a7af022f58c68b}{}\label{dir_10eb6422e80bd721a9a7af022f58c68b}\index{G:/ids/dragonfly/docs/core Directory Reference@{G:/ids/dragonfly/docs/core Directory Reference}}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This section contains documentation for the core functions of Arma\+Dragonfly\+Client that handle initialization, process management, and scheduling.\hypertarget{README.md_autotoc_md133}{}\doxysubsection{\texorpdfstring{Available Functions}{Available Functions}}\label{README.md_autotoc_md133}
|
|
|
|
\begin{DoxyItemize}
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2core_2add_task}{add\+Task}{0} -\/ Add a task to the scheduler
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2core_2handler}{handler}{0} -\/ Handle callbacks from the extension
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2core_2init}{init}{0} -\/ Initialize the database system
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2core_2print_addon_name}{print\+Addon\+Name}{0} -\/ Print the addon name
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2core_2process_queue}{process\+Queue}{0} -\/ Process queued database operations
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2core_2scheduler}{scheduler}{0} -\/ Schedule database operations
|
|
\item \doxysectlink{md__g_1_2ids_2dragonfly_2docs_2core_2test}{test}{0} -\/ Test the database connection
|
|
\end{DoxyItemize}\hypertarget{README.md_autotoc_md134}{}\doxysubsection{\texorpdfstring{Example Usage}{Example Usage}}\label{README.md_autotoc_md134}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{//\ Initialize\ the\ database}
|
|
\DoxyCodeLine{[]\ call\ dragonfly\_db\_fnc\_init;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Test\ the\ database\ connection}
|
|
\DoxyCodeLine{[]\ call\ dragonfly\_db\_fnc\_test;}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{README.md_autotoc_md135}{}\doxysubsection{\texorpdfstring{Related Categories}{Related Categories}}\label{README.md_autotoc_md135}
|
|
|
|
\begin{DoxyItemize}
|
|
\item Basic Data Operations
|
|
\item Hash Operations
|
|
\item List Operations
|
|
\end{DoxyItemize} |