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.
52 lines
2.3 KiB
XML
52 lines
2.3 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_10eb6422e80bd721a9a7af022f58c68b" xml:lang="en-US">
|
|
<title>G:/ids/dragonfly/docs/core Directory Reference</title>
|
|
<indexterm><primary>G:/ids/dragonfly/docs/core Directory Reference</primary></indexterm>
|
|
<section>
|
|
<title>Detailed Description</title>
|
|
|
|
<para>This section contains documentation for the core functions of ArmaDragonflyClient that handle initialization, process management, and scheduling.</para>
|
|
<section xml:id="_README.md_1autotoc_md133">
|
|
<title>Available Functions</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2core_2add_task">addTask</link> - Add a task to the scheduler</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2core_2handler">handler</link> - Handle callbacks from the extension</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2core_2init">init</link> - Initialize the database system</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2core_2print_addon_name">printAddonName</link> - Print the addon name</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2core_2process_queue">processQueue</link> - Process queued database operations</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2core_2scheduler">scheduler</link> - Schedule database operations</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2core_2test">test</link> - Test the database connection</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md134">
|
|
<title>Example Usage</title>
|
|
<para><literallayout><computeroutput>// Initialize the database
|
|
[] call dragonfly_db_fnc_init;
|
|
|
|
// Test the database connection
|
|
[] call dragonfly_db_fnc_test;
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md135">
|
|
<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>
|