ramdb/api/latex/dir_771164b9325b04f1442f7a3ffa8ecb89.tex
Jacob Schmidt ee1dd91b7f
All checks were successful
Build / Build (push) Successful in 40s
feat: Add documentation for fetch function
This commit adds documentation for the `ramdb_db_fnc_fetch` function. The documentation explains the function's purpose, which is to handle data chunks received from the database extension when data is too large to be returned in a single callback. The documentation includes a title, icon, and excerpt for better readability and understanding.
2025-03-30 17:16:31 -05:00

32 lines
1.8 KiB
TeX

\doxysection{docs/core Directory Reference}
\hypertarget{dir_771164b9325b04f1442f7a3ffa8ecb89}{}\label{dir_771164b9325b04f1442f7a3ffa8ecb89}\index{docs/core Directory Reference@{docs/core Directory Reference}}
\doxysubsection{Detailed Description}
This section contains documentation for the core functions of Arma\+RAMDb that handle initialization, process management, and scheduling.\hypertarget{README.md_autotoc_md147}{}\doxysubsection{\texorpdfstring{Available Functions}{Available Functions}}\label{README.md_autotoc_md147}
\begin{DoxyItemize}
\item \doxysectlink{md_docs_2core_2add_task}{add\+Task}{0} -\/ Add a task to the scheduler
\item \doxysectlink{md_docs_2core_2handler}{handler}{0} -\/ Handle callbacks from the extension
\item \doxysectlink{md_docs_2core_2init}{init}{0} -\/ Initialize the database system
\item \doxysectlink{md_docs_2core_2print_addon_name}{print\+Addon\+Name}{0} -\/ Print the addon name
\item \doxysectlink{md_docs_2core_2process_queue}{process\+Queue}{0} -\/ Process queued database operations
\item \doxysectlink{md_docs_2core_2scheduler}{scheduler}{0} -\/ Schedule database operations
\item \doxysectlink{md_docs_2core_2test}{test}{0} -\/ Test the database connection
\end{DoxyItemize}\hypertarget{README.md_autotoc_md148}{}\doxysubsection{\texorpdfstring{Example Usage}{Example Usage}}\label{README.md_autotoc_md148}
\begin{DoxyCode}{0}
\DoxyCodeLine{//\ Initialize\ the\ database}
\DoxyCodeLine{[]\ call\ ramdb\_db\_fnc\_init;}
\DoxyCodeLine{}
\DoxyCodeLine{//\ Test\ the\ database\ connection}
\DoxyCodeLine{[]\ call\ ramdb\_db\_fnc\_test;}
\end{DoxyCode}
\hypertarget{README.md_autotoc_md149}{}\doxysubsection{\texorpdfstring{Related Categories}{Related Categories}}\label{README.md_autotoc_md149}
\begin{DoxyItemize}
\item Basic Data Operations
\item Hash Operations
\item List Operations
\end{DoxyItemize}