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.
57 lines
2.6 KiB
XML
57 lines
2.6 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_72c6efb7383bf0530aa073c1e7428252" xml:lang="en-US">
|
|
<title>G:/ids/dragonfly/docs/list Directory Reference</title>
|
|
<indexterm><primary>G:/ids/dragonfly/docs/list Directory Reference</primary></indexterm>
|
|
<section>
|
|
<title>Detailed Description</title>
|
|
|
|
<para>This section contains documentation for the list operations of ArmaDragonflyClient that allow for working with ordered collections of items.</para>
|
|
<section xml:id="_README.md_1autotoc_md341">
|
|
<title>Available Functions</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2list_2list_add">listAdd</link> - Add an item to a list</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2list_2list_get">listGet</link> - Get items from a list</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2list_2list_load">listLoad</link> - Load a list from the database</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2list_2list_remove">listRemove</link> - Remove an item from a list</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md__g_1_2ids_2dragonfly_2docs_2list_2list_set">listSet</link> - Set an item in a list</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md342">
|
|
<title>Example Usage</title>
|
|
<para><literallayout><computeroutput>// Add an item to a list
|
|
["myList", ["myItem"]] call dragonfly_db_fnc_listAdd;
|
|
|
|
// Set an item at a specific index
|
|
["myList", 0, [myNewValue]] call dragonfly_db_fnc_listSet;
|
|
|
|
// Get an item at a specific index
|
|
["myList", 0, "myFunction"] call dragonfly_db_fnc_listGet;
|
|
|
|
// Load all items from a list
|
|
["myList", "myFunction"] call dragonfly_db_fnc_listLoad;
|
|
|
|
// Remove an item at a specific index
|
|
["myList", 0] call dragonfly_db_fnc_listRemove;
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md343">
|
|
<title>Related Categories</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para>Core Functions</para>
|
|
</listitem><listitem>
|
|
<para>Basic Data Operations</para>
|
|
</listitem><listitem>
|
|
<para>Hash Operations </para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
</section>
|