0siribix/mod-cleaner
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Re-generate HTML docs

Browse Source
This commit is contained in:
Jordan Irwin 2021-07-12 18:12:00 -07:00
parent bb36a723d3
commit 02489ec530
4 changed files with 69 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/index.html
View File

@ -63,7 +63,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 2021-07-12 15:47:16 </i>
<i style="float:right;">Last updated 2021-07-12 18:11:46 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

79
docs/reference/topics/api.html
View File

@ -67,24 +67,32 @@
<td class="summary">Retrieves list of nodes to be replaced.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.remove_entity">cleaner.remove_entity (src)</a></td>
<td class="name" nowrap><a href="#cleaner.register_entity_removal">cleaner.register_entity_removal (src)</a></td>
<td class="summary">Registers an entity to be removed.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.remove_node">cleaner.remove_node (src)</a></td>
<td class="name" nowrap><a href="#cleaner.register_node_removal">cleaner.register_node_removal (src)</a></td>
<td class="summary">Registers a node to be removed.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.replace_item">cleaner.replace_item (src, tgt)</a></td>
<td class="name" nowrap><a href="#cleaner.register_item_replacement">cleaner.register_item_replacement (src, tgt)</a></td>
<td class="summary">Registeres an item to be replaced.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.replace_node">cleaner.replace_node (src, tgt)</a></td>
<td class="name" nowrap><a href="#cleaner.register_node_replacement">cleaner.register_node_replacement (src, tgt)</a></td>
<td class="summary">Registers a node to be replaced.</td>
</tr>
</table>
<h2><a href="#Unsafe_methods">Unsafe methods </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#cleaner.get_remove_ores">cleaner.get_remove_ores ()</a></td>
<td class="summary">Retrieves list of ores to be removed.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.register_ore_removal">cleaner.register_ore_removal (src)</a></td>
<td class="summary">Registers an ore to be removed after server startup.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.remove_ore">cleaner.remove_ore (src)</a></td>
<td class="summary">Removes an ore definition.</td>
@ -143,8 +151,8 @@
</dd>
<dt>
<a name = "cleaner.remove_entity"></a>
<strong>cleaner.remove_entity (src)</strong>
<a name = "cleaner.register_entity_removal"></a>
<strong>cleaner.register_entity_removal (src)</strong>
</dt>
<dd>
Registers an entity to be removed.
@ -166,8 +174,8 @@
</dd>
<dt>
<a name = "cleaner.remove_node"></a>
<strong>cleaner.remove_node (src)</strong>
<a name = "cleaner.register_node_removal"></a>
<strong>cleaner.register_node_removal (src)</strong>
</dt>
<dd>
Registers a node to be removed.
@ -189,8 +197,8 @@
</dd>
<dt>
<a name = "cleaner.replace_item"></a>
<strong>cleaner.replace_item (src, tgt)</strong>
<a name = "cleaner.register_item_replacement"></a>
<strong>cleaner.register_item_replacement (src, tgt)</strong>
</dt>
<dd>
Registeres an item to be replaced.
@ -216,8 +224,8 @@
</dd>
<dt>
<a name = "cleaner.replace_node"></a>
<strong>cleaner.replace_node (src, tgt)</strong>
<a name = "cleaner.register_node_replacement"></a>
<strong>cleaner.register_node_replacement (src, tgt)</strong>
</dt>
<dd>
Registers a node to be replaced.
@ -249,6 +257,51 @@
Enabled with <code>cleaner.unsafe</code> setting.
</div>
<dl class="function">
<dt>
<a name = "cleaner.get_remove_ores"></a>
<strong>cleaner.get_remove_ores ()</strong>
</dt>
<dd>
Retrieves list of ores to be removed.
</ul>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
Ores to be replaced.
</ol>
</dd>
<dt>
<a name = "cleaner.register_ore_removal"></a>
<strong>cleaner.register_ore_removal (src)</strong>
</dt>
<dd>
Registers an ore to be removed after server startup.
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">src</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
Ore technical name.
</li>
</ul>
</dd>
<dt>
<a name = "cleaner.remove_ore"></a>
<strong>cleaner.remove_ore (src)</strong>
@ -279,7 +332,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 2021-07-12 15:47:16 </i>
<i style="float:right;">Last updated 2021-07-12 18:11:46 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/reference/topics/commands.html
View File

@ -244,7 +244,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 2021-07-12 15:47:16 </i>
<i style="float:right;">Last updated 2021-07-12 18:11:46 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/reference/topics/settings.html
View File

@ -101,7 +101,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 2021-07-12 15:47:16 </i>
<i style="float:right;">Last updated 2021-07-12 18:11:46 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>