ee1dd91b7f
All checks were successful
Build / Build (push) Successful in 40s
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.
52 lines
2.1 KiB
XML
52 lines
2.1 KiB
XML
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_dir_771164b9325b04f1442f7a3ffa8ecb89" xml:lang="en-US">
|
|
<title>docs/core Directory Reference</title>
|
|
<indexterm><primary>docs/core Directory Reference</primary></indexterm>
|
|
<section>
|
|
<title>Detailed Description</title>
|
|
|
|
<para>This section contains documentation for the core functions of ArmaRAMDb that handle initialization, process management, and scheduling.</para>
|
|
<section xml:id="_README.md_1autotoc_md147">
|
|
<title>Available Functions</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para><link linkend="_md_docs_2core_2add_task">addTask</link> - Add a task to the scheduler</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2core_2handler">handler</link> - Handle callbacks from the extension</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2core_2init">init</link> - Initialize the database system</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2core_2print_addon_name">printAddonName</link> - Print the addon name</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2core_2process_queue">processQueue</link> - Process queued database operations</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2core_2scheduler">scheduler</link> - Schedule database operations</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2core_2test">test</link> - Test the database connection</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md148">
|
|
<title>Example Usage</title>
|
|
<para><literallayout><computeroutput>// Initialize the database
|
|
[] call ramdb_db_fnc_init;
|
|
|
|
// Test the database connection
|
|
[] call ramdb_db_fnc_test;
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md149">
|
|
<title>Related Categories</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para>Basic Data Operations</para>
|
|
</listitem><listitem>
|
|
<para>Hash Operations</para>
|
|
</listitem><listitem>
|
|
<para>List Operations </para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
</section>
|