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.
147 lines
11 KiB
HTML
147 lines
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>ArmaDragonflyClient: Related Pages</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">ArmaDragonflyClient
|
|
</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('pages.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">Related Pages</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock">Here is a list of all related documentation pages:</div><div class="directory">
|
|
<table class="directory">
|
|
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="df/d12/md__g_1_2ids_2dragonfly_2docs_2basic_2delete.html" target="_self">delete</a></td><td class="desc"></td></tr>
|
|
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d4/d99/md__g_1_2ids_2dragonfly_2docs_2basic_2fetch.html" target="_self">fetch</a></td><td class="desc"></td></tr>
|
|
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d3/dcb/md__g_1_2ids_2dragonfly_2docs_2basic_2get.html" target="_self">get</a></td><td class="desc"></td></tr>
|
|
<tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d2/dce/md__g_1_2ids_2dragonfly_2docs_2basic_2save.html" target="_self">save</a></td><td class="desc"></td></tr>
|
|
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d9/d9c/md__g_1_2ids_2dragonfly_2docs_2basic_2set.html" target="_self">set</a></td><td class="desc"></td></tr>
|
|
<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="dd/d3b/md__g_1_2ids_2dragonfly_2docs_2core_2add_task.html" target="_self">addTask</a></td><td class="desc"></td></tr>
|
|
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d4/d43/md__g_1_2ids_2dragonfly_2docs_2core_2handler.html" target="_self">handler</a></td><td class="desc"></td></tr>
|
|
<tr id="row_7_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="dc/d36/md__g_1_2ids_2dragonfly_2docs_2core_2init.html" target="_self">init</a></td><td class="desc"></td></tr>
|
|
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d4/d7c/md__g_1_2ids_2dragonfly_2docs_2core_2print_addon_name.html" target="_self">printAddonName</a></td><td class="desc"></td></tr>
|
|
<tr id="row_9_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d0/d0e/md__g_1_2ids_2dragonfly_2docs_2core_2process_queue.html" target="_self">processQueue</a></td><td class="desc"></td></tr>
|
|
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d0/df6/md__g_1_2ids_2dragonfly_2docs_2core_2scheduler.html" target="_self">scheduler</a></td><td class="desc"></td></tr>
|
|
<tr id="row_11_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d6/d7e/md__g_1_2ids_2dragonfly_2docs_2core_2test.html" target="_self">test</a></td><td class="desc"></td></tr>
|
|
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d9/de8/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get.html" target="_self">hashGet</a></td><td class="desc"></td></tr>
|
|
<tr id="row_13_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="da/d08/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all.html" target="_self">hashGetAll</a></td><td class="desc"></td></tr>
|
|
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d2/d23/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_all_id.html" target="_self">hashGetAllId</a></td><td class="desc"></td></tr>
|
|
<tr id="row_15_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d2/d28/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_get_id.html" target="_self">hashGetId</a></td><td class="desc"></td></tr>
|
|
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d0/df2/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set.html" target="_self">hashSet</a></td><td class="desc"></td></tr>
|
|
<tr id="row_17_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="da/d74/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_bulk.html" target="_self">hashSetBulk</a></td><td class="desc"></td></tr>
|
|
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d4/d99/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id.html" target="_self">hashSetId</a></td><td class="desc"></td></tr>
|
|
<tr id="row_19_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="de/da6/md__g_1_2ids_2dragonfly_2docs_2hash_2hash_set_id_bulk.html" target="_self">hashSetIdBulk</a></td><td class="desc"></td></tr>
|
|
<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="da/d2c/md__g_1_2ids_2dragonfly_2docs_2list_2list_add.html" target="_self">listAdd</a></td><td class="desc"></td></tr>
|
|
<tr id="row_21_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d3/ddf/md__g_1_2ids_2dragonfly_2docs_2list_2list_get.html" target="_self">listGet</a></td><td class="desc"></td></tr>
|
|
<tr id="row_22_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d9/db3/md__g_1_2ids_2dragonfly_2docs_2list_2list_load.html" target="_self">listLoad</a></td><td class="desc"></td></tr>
|
|
<tr id="row_23_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d1/d22/md__g_1_2ids_2dragonfly_2docs_2list_2list_remove.html" target="_self">listRemove</a></td><td class="desc"></td></tr>
|
|
<tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><a class="el" href="d2/dc5/md__g_1_2ids_2dragonfly_2docs_2list_2list_set.html" target="_self">listSet</a></td><td class="desc"></td></tr>
|
|
</table>
|
|
</div><!-- directory -->
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|