Re-generate HTML docs
This commit is contained in:
Jordan Irwin
parent
13a6fd04be
commit
ad2fc046a1
@ -32,7 +32,9 @@
|
||||
|
||||
<h2>Topics</h2>
|
||||
<ul class="">
|
||||
<li><a href="topics/settings.html">settings</a></li>
|
||||
<li><a href="topics/api.html">api</a></li>
|
||||
<li><a href="topics/commands.html">commands</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -43,17 +45,25 @@
|
||||
|
||||
<h2>Topics</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="topics/settings.html">settings</a></td>
|
||||
<td class="summary">Cleaner Settings</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="topics/api.html">api</a></td>
|
||||
<td class="summary">Cleaner API</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="topics/commands.html">commands</a></td>
|
||||
<td class="summary">Cleaner Chat Commands</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</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 2021-07-12 09:02:05 </i>
|
||||
<i style="float:right;">Last updated 2021-07-12 15:47:16 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
@ -34,12 +34,15 @@
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#Unsafe_methods">Unsafe methods </a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Topics</h2>
|
||||
<ul class="">
|
||||
<li><a href="../topics/settings.html">settings</a></li>
|
||||
<li><strong>api</strong></li>
|
||||
<li><a href="../topics/commands.html">commands</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -80,6 +83,13 @@
|
||||
<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.remove_ore">cleaner.remove_ore (src)</a></td>
|
||||
<td class="summary">Removes an ore definition.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
@ -95,6 +105,8 @@
|
||||
<dd>
|
||||
Retrieves list of items to be replaced.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
@ -115,6 +127,8 @@
|
||||
<dd>
|
||||
Retrieves list of nodes to be replaced.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
@ -135,6 +149,8 @@
|
||||
<dd>
|
||||
Registers an entity to be removed.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
@ -156,6 +172,8 @@
|
||||
<dd>
|
||||
Registers a node to be removed.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
@ -177,6 +195,8 @@
|
||||
<dd>
|
||||
Registeres an item to be replaced.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
@ -202,6 +222,8 @@
|
||||
<dd>
|
||||
Registers a node to be replaced.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
@ -219,6 +241,36 @@
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header has-description"><a name="Unsafe_methods"></a>Unsafe methods </h2>
|
||||
|
||||
<div class="section-description">
|
||||
Enabled with <code>cleaner.unsafe</code> setting.
|
||||
</div>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "cleaner.remove_ore"></a>
|
||||
<strong>cleaner.remove_ore (src)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Removes an ore definition.
|
||||
|
||||
</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>
|
||||
</dl>
|
||||
|
||||
@ -227,7 +279,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 09:02:05 </i>
|
||||
<i style="float:right;">Last updated 2021-07-12 15:47:16 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
251
docs/reference/topics/commands.html
Normal file
251
docs/reference/topics/commands.html
Normal file
@ -0,0 +1,251 @@
|
||||
<!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>Cleaner mod for Minetest</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>Cleaner</h1>
|
||||
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Chat_Commands">Chat Commands</a></li>
|
||||
<li><a href="#Unsafe_commands">Unsafe commands </a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Topics</h2>
|
||||
<ul class="">
|
||||
<li><a href="../topics/settings.html">settings</a></li>
|
||||
<li><a href="../topics/api.html">api</a></li>
|
||||
<li><strong>commands</strong></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Topic <code>commands</code></h1>
|
||||
<p>Cleaner Chat Commands</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Chat_Commands">Chat Commands</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#remove_entity">remove_entity</a></td>
|
||||
<td class="summary">Removes nearby entities.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#remove_node">remove_node</a></td>
|
||||
<td class="summary">Removes nearby nodes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#replace_item">replace_item</a></td>
|
||||
<td class="summary">Replaces an item.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#replace_item">replace_item</a></td>
|
||||
<td class="summary">Replaces nearby nodes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#find_unknown_nodes">find_unknown_nodes</a></td>
|
||||
<td class="summary">Checks for nearby unknown nodes.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Unsafe_commands">Unsafe commands </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#remove_ore">remove_ore</a></td>
|
||||
<td class="summary">Registers an ore to be removed.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Chat_Commands"></a>Chat Commands</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "remove_entity"></a>
|
||||
<strong>remove_entity</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Removes nearby entities.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">entity</span>
|
||||
Entity technical name.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "remove_node"></a>
|
||||
<strong>remove_node</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Removes nearby nodes.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">node</span>
|
||||
Node technical name.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "replace_item"></a>
|
||||
<strong>replace_item</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Replaces an item. </p>
|
||||
|
||||
<p> FIXME: inventory icons not updated
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">old_item</span>
|
||||
Technical name of item to replace.
|
||||
</li>
|
||||
<li><span class="parameter">new_item</span>
|
||||
Technical name of item to be used in place.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "replace_item"></a>
|
||||
<strong>replace_item</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Replaces nearby nodes.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">old_node</span>
|
||||
Technical name of node to replace.
|
||||
</li>
|
||||
<li><span class="parameter">new_node</span>
|
||||
Technical name of node to be used in place.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "find_unknown_nodes"></a>
|
||||
<strong>find_unknown_nodes</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Checks for nearby unknown nodes.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">radius</span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
Search radius.
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header has-description"><a name="Unsafe_commands"></a>Unsafe commands </h2>
|
||||
|
||||
<div class="section-description">
|
||||
Enabled with <code>cleaner.unsafe</code> setting.
|
||||
</div>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "remove_ore"></a>
|
||||
<strong>remove_ore</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Registers an ore to be removed.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">ore</span>
|
||||
Ore technical name.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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 2021-07-12 15:47:16 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
108
docs/reference/topics/settings.html
Normal file
108
docs/reference/topics/settings.html
Normal file
@ -0,0 +1,108 @@
|
||||
<!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>Cleaner mod for Minetest</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>Cleaner</h1>
|
||||
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Settings">Settings</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Topics</h2>
|
||||
<ul class="">
|
||||
<li><strong>settings</strong></li>
|
||||
<li><a href="../topics/api.html">api</a></li>
|
||||
<li><a href="../topics/commands.html">commands</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Topic <code>settings</code></h1>
|
||||
<p>Cleaner Settings</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Settings">Settings</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#cleaner.unsafe">cleaner.unsafe</a></td>
|
||||
<td class="summary">Enables unsafe methods.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Settings"></a>Settings</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "cleaner.unsafe"></a>
|
||||
<strong>cleaner.unsafe</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Enables unsafe methods. </p>
|
||||
|
||||
<p> <code>cleaner.remove_ore</code>
|
||||
|
||||
<h3>Setting Type:</h3>
|
||||
<ul>
|
||||
bool
|
||||
</ul>
|
||||
<h3>Default Value:</h3>
|
||||
<ul>
|
||||
false
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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 2021-07-12 15:47:16 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
Loading…
x
Reference in New Issue
Block a user