Added LDoc comments for new files, ready to merge
This commit is contained in:
SkylarHew
@ -24,7 +24,7 @@
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>modpol</h1>
|
||||
<h1>Modpol</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
@ -36,35 +36,36 @@
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Basic Functions</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/modpol.interactions.html">modpol.interactions</a></li>
|
||||
<li><a href="../modules/modpol.orgs.base.html">modpol.orgs.base</a></li>
|
||||
<li><a href="../modules/modpol.orgs.process.html">modpol.orgs.process</a></li>
|
||||
<li><a href="../modules/modpol.util.misc.html">modpol.util.misc</a></li>
|
||||
<li><a href="../modules/modpol_minetest.api.html">modpol_minetest.api</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Core Modules</h2>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><strong>modpol.interactions</strong></li>
|
||||
<li><a href="../modules/add_child_org_consent.html">add_child_org_consent</a></li>
|
||||
<li><a href="../modules/change_modules.html">change_modules</a></li>
|
||||
<li><a href="../modules/change_modules.html">change_modules</a></li>
|
||||
<li><a href="../modules/consent.html">consent</a></li>
|
||||
<li><a href="../modules/create_token.html">create_token</a></li>
|
||||
<li><a href="../modules/defer_consent.html">defer_consent</a></li>
|
||||
<li><a href="../modules/display_processes.html">display_processes</a></li>
|
||||
<li><a href="../modules/join_org.html">join_org</a></li>
|
||||
<li><a href="../modules/join_org_consent.html">join_org_consent</a></li>
|
||||
<li><a href="../modules/leave_org.html">leave_org</a></li>
|
||||
<li><a href="../modules/message_org.html">message_org</a></li>
|
||||
<li><a href="../modules/randomizer.html">randomizer</a></li>
|
||||
<li><a href="../modules/remove_child_consent.html">remove_child_consent</a></li>
|
||||
<li><a href="../modules/remove_member_consent.html">remove_member_consent</a></li>
|
||||
<li><a href="../modules/remove_org.html">remove_org</a></li>
|
||||
<li><a href="../modules/remove_org_consent.html">remove_org_consent</a></li>
|
||||
<li><a href="../modules/remove_process.html">remove_process</a></li>
|
||||
<li><a href="../modules/rename_org_consent.html">rename_org_consent</a></li>
|
||||
<li><a href="../modules/send_token.html">send_token</a></li>
|
||||
<li><a href="../modules/module_template.html">module_template</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Minetest Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/tokenomics.html">tokenomics</a></li>
|
||||
<li><a href="../modules/modpol.orgs.base.html">modpol.orgs.base</a></li>
|
||||
<li><a href="../modules/modpol.orgs.process.html">modpol.orgs.process</a></li>
|
||||
<li><a href="../modules/modpol.util.misc.html">modpol.util.misc</a></li>
|
||||
<li><a href="../modules/modpol_minetest.api.html">modpol_minetest.api</a></li>
|
||||
<li><a href="../modules/priv_to_org.html">priv_to_org</a></li>
|
||||
<li><a href="../modules/modpol_minetest.overrides.interactions.html">modpol_minetest.overrides.interactions</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -89,19 +90,36 @@
|
||||
<td class="summary">Output: Displays a menu of org-specific commands to the user</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#modpol.interactions.message">modpol.interactions.message (user, message)</a></td>
|
||||
<td class="summary">Output: Prints message to CLI</td>
|
||||
<td class="name" nowrap><a href="#modpol.interactions.user_dashboard">modpol.interactions.user_dashboard (viewer, user, completion)</a></td>
|
||||
<td class="summary">Function: modpol.interactions.user_dashboard
|
||||
Displays a dashboard about a particular user</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#modpol.interactions.text_query">modpol.interactions.text_query (user, query, func)</a></td>
|
||||
<td class="summary">Output: Applies "func" to user input.</td>
|
||||
<td class="name" nowrap><a href="#modpol.interactions.message">modpol.interactions.message (user, message)</a></td>
|
||||
<td class="summary">Prints message to CLI.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#modpol.interactions.message_user">modpol.interactions.message_user (sender, recipient)</a></td>
|
||||
<td class="summary">Gets and sends a message from one user to another</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#modpol.interactions.display">modpol.interactions.display (user, title, message, done)</a></td>
|
||||
<td class="summary">Displays complex data to a user</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#modpol.interactions.text_query">modpol.interactions.text_query (User, Query, func)</a></td>
|
||||
<td class="summary">Applies "func" to user input.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#modpol.interactions.dropdown_query">modpol.interactions.dropdown_query (user, label, options, func)</a></td>
|
||||
<td class="summary">Output: Calls func on choice.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#modpol.binary_poll_user">modpol.binary_poll_user (user, question, func)</a></td>
|
||||
<td class="name" nowrap><a href="#modpol.interactions.checkbox_query">modpol.interactions.checkbox_query (user, label, options, func)</a></td>
|
||||
<td class="summary">Allows user to select from a set of options</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#modpol.interactions.binary_poll_user">modpol.interactions.binary_poll_user (user, question, func)</a></td>
|
||||
<td class="summary">Output: Applies "func" to user input.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -159,13 +177,41 @@
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "modpol.interactions.user_dashboard"></a>
|
||||
<strong>modpol.interactions.user_dashboard (viewer, user, completion)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Function: modpol.interactions.user_dashboard
|
||||
Displays a dashboard about a particular user
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">viewer</span>
|
||||
Name of user viewing the dashboard (string)
|
||||
</li>
|
||||
<li><span class="parameter">user</span>
|
||||
Name of user being viewed (string)
|
||||
</li>
|
||||
<li><span class="parameter">completion</span>
|
||||
Optional function to call on Done button
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "modpol.interactions.message"></a>
|
||||
<strong>modpol.interactions.message (user, message)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Output: Prints message to CLI
|
||||
Prints message to CLI.
|
||||
Buttons: message, done
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
@ -184,20 +230,72 @@
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "modpol.interactions.text_query"></a>
|
||||
<strong>modpol.interactions.text_query (user, query, func)</strong>
|
||||
<a name = "modpol.interactions.message_user"></a>
|
||||
<strong>modpol.interactions.message_user (sender, recipient)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Output: Applies "func" to user input.
|
||||
Func input: user input (string)
|
||||
Gets and sends a message from one user to another
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">sender</span>
|
||||
Name of user sending (string)
|
||||
</li>
|
||||
<li><span class="parameter">recipient</span>
|
||||
Name of user receiving (string)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "modpol.interactions.display"></a>
|
||||
<strong>modpol.interactions.display (user, title, message, done)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Displays complex data to a user
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">user</span>
|
||||
Name of target user (string)
|
||||
</li>
|
||||
<li><span class="parameter">title</span>
|
||||
Title of display (string)
|
||||
</li>
|
||||
<li><span class="parameter">message</span>
|
||||
Content of message (string or table of strings)
|
||||
</li>
|
||||
<li><span class="parameter">done</span>
|
||||
Optional function for what happens when user is done
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "modpol.interactions.text_query"></a>
|
||||
<strong>modpol.interactions.text_query (User, Query, func)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Applies "func" to user input.
|
||||
Func input: user input (string)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">User</span>
|
||||
(string)
|
||||
</li>
|
||||
<li><span class="parameter">query</span>
|
||||
<li><span class="parameter">Query</span>
|
||||
(string)
|
||||
</li>
|
||||
<li><span class="parameter">func</span>
|
||||
@ -216,7 +314,7 @@
|
||||
</dt>
|
||||
<dd>
|
||||
Output: Calls func on choice.
|
||||
func input: choice (string)
|
||||
Func input: choice (string)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
@ -241,8 +339,37 @@
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "modpol.binary_poll_user"></a>
|
||||
<strong>modpol.binary_poll_user (user, question, func)</strong>
|
||||
<a name = "modpol.interactions.checkbox_query"></a>
|
||||
<strong>modpol.interactions.checkbox_query (user, label, options, func)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Allows user to select from a set of options
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">user</span>
|
||||
Name of user (string)
|
||||
</li>
|
||||
<li><span class="parameter">label</span>
|
||||
Query for user before options (string)
|
||||
</li>
|
||||
<li><span class="parameter">options</span>
|
||||
Table of options and their checked status in the form {{"option_1_string", true}, {"option_2_string", false}}
|
||||
</li>
|
||||
<li><span class="parameter">func</span>
|
||||
Function to be called with param "input", made up of the corrected table in the same format as the param options
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "modpol.interactions.binary_poll_user"></a>
|
||||
<strong>modpol.interactions.binary_poll_user (user, question, func)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Output: Applies "func" to user input.
|
||||
@ -300,7 +427,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2022-01-20 10:54:01 </i>
|
||||
<i style="float:right;">Last updated 2022-01-23 18:18:51 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user