Modpol/modpol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added ldoc comments for all lua modules and generated docs in documentation index.html

Browse Source
This commit is contained in:
SkylarHew
2022-01-20 11:04:44 -07:00
parent 5085d87f68
commit da7b996a8b
41 changed files with 4307 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

145
documentation/doc/modules/rename_org_consent.html Normal file
View File

@@ -0,0 +1,145 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>modpol</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</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>
<ul class="nowrap">
<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/consent.html">consent</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/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/rename_org_consent.html">rename_org_consent</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/priv_to_org.html">priv_to_org</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>rename_org_consent</code></h1>
<p>Rename org (consent)
A simple module that calls a consent process on an org to rename it.</p>
<p>
Depends on the Consent module.</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#initiate">initiate (result)</a></td>
<td class="summary">Renames the org after consent is reached</td>
</tr>
<tr>
<td class="name" nowrap><a href="#complete">complete ()</a></td>
<td class="summary">Changes the name of the org after consent is reached</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "initiate"></a>
<strong>initiate (result)</strong>
</dt>
<dd>
Renames the org after consent is reached
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">result</span>
</li>
</ul>
</dd>
<dt>
<a name = "complete"></a>
<strong>complete ()</strong>
</dt>
<dd>
Changes the name of the org after consent is reached
</dd>
</dl>
</div> <!-- id="content" -->
</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>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>