Re-generate HTML docs

2021-07-30 16:17:09 -07:00 · 2021-07-30 16:17:09 -07:00 · 3a708a03b6
commit 3a708a03b6
parent e0bf9a56e6
6 changed files with 181 additions and 14 deletions
--- a/docs/reference/index.html
+++ b/docs/reference/index.html
@ -36,6 +36,7 @@
  <li><a href="topics/api.html">api</a></li>
  <li><a href="topics/commands.html">commands</a></li>
  <li><a href="topics/tools.html">tools</a></li>
+  <li><a href="topics/config.html">config</a></li>
 </ul>

 </div>
@ -62,13 +63,17 @@
 		<td class="name"  nowrap><a href="topics/tools.html">tools</a></td>
 		<td class="summary">Cleaner Tools</td>
 	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="topics/config.html">config</a></td>
+		<td class="summary">World Path Configuration</td>
+	</tr>
 </table>

 </div> <!-- id="content" -->
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
-<i style="float:right;">Last updated 2021-07-29 13:38:35 </i>
+<i style="float:right;">Last updated 2021-07-30 16:16:51 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
--- a/docs/reference/topics/api.html
+++ b/docs/reference/topics/api.html
@ -44,6 +44,7 @@
  <li><strong>api</strong></li>
  <li><a href="../topics/commands.html">commands</a></li>
  <li><a href="../topics/tools.html">tools</a></li>
+  <li><a href="../topics/config.html">config</a></li>
 </ul>

 </div>
@ -389,7 +390,7 @@
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
-<i style="float:right;">Last updated 2021-07-29 13:38:35 </i>
+<i style="float:right;">Last updated 2021-07-30 16:16:51 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
--- a/docs/reference/topics/commands.html
+++ b/docs/reference/topics/commands.html
@ -44,6 +44,7 @@
  <li><a href="../topics/api.html">api</a></li>
  <li><strong>commands</strong></li>
  <li><a href="../topics/tools.html">tools</a></li>
+  <li><a href="../topics/config.html">config</a></li>
 </ul>

 </div>
@ -306,7 +307,7 @@
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
-<i style="float:right;">Last updated 2021-07-29 13:38:35 </i>
+<i style="float:right;">Last updated 2021-07-30 16:16:51 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
--- a/docs/reference/topics/config.html
+++ b/docs/reference/topics/config.html
@ -0,0 +1,151 @@
+<!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="#JSON_Configurations">JSON Configurations</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><a href="../topics/commands.html">commands</a></li>
+  <li><a href="../topics/tools.html">tools</a></li>
+  <li><strong>config</strong></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Topic <code>config</code></h1>
+<p>World Path Configuration</p>
+<p>
+
+</p>
+
+
+<h2><a href="#JSON_Configurations">JSON Configurations</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#cleaner.json">cleaner.json</a></td>
+	<td class="summary">Main configuration file.</td>
+	</tr>
+</table>
+
+<br/>
+<br/>
+
+
+    <h2 class="section-header "><a name="JSON_Configurations"></a>JSON Configurations</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "cleaner.json"></a>
+    <strong>cleaner.json</strong>
+    </dt>
+    <dd>
+    Main configuration file. </p>
+
+<p>  Registering items, entities, etc. for cleaning can be done in <strong><em>cleaner.json</em></strong>
+  in the world directory (<code>&lt;world_path&gt;/cleaner.json</code>). If it does not exist
+  it will be created automatically when the server is started.</p>
+
+<p>  It is formatted as follows:</p>
+
+<pre><code>{
+  "entities" :
+  {
+    "remove" : []
+  },
+  "items" :
+  {
+    "replace" : {}
+  },
+  "nodes" :
+  {
+    "remove" : [],
+    "replace" : {}
+  },
+  "ores" :
+  {
+    "remove" : []
+  }
+}
+</code></pre>
+
+<p>  <code>remove</code> key works for nodes, entities, &amp; ores. <code>replace</code> key works for
+  nodes &amp; items. Their functions are self-explanatory.
+
+    </ul>
+    </ul>
+    </ul>
+    </ul>
+
+
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">Cleaning nodes example:
+{
+  <span class="string">"nodes"</span> :
+  {
+    <span class="string">"remove"</span> : [
+      <span class="string">"old:node_1"</span>,
+      <span class="string">"old:node_2"</span>,
+    ],
+    <span class="string">"replace"</span> : {
+      <span class="string">"old:node_3"</span> : <span class="string">"new:node_1"</span>,
+      <span class="string">"old:node_4"</span> : <span class="string">"new:node_2"</span>,
+    }
+  },
+}</pre>
+    </ul>
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
+<i style="float:right;">Last updated 2021-07-30 16:16:51 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>
--- a/docs/reference/topics/settings.html
+++ b/docs/reference/topics/settings.html
@ -43,6 +43,7 @@
  <li><a href="../topics/api.html">api</a></li>
  <li><a href="../topics/commands.html">commands</a></li>
  <li><a href="../topics/tools.html">tools</a></li>
+  <li><a href="../topics/config.html">config</a></li>
 </ul>

 </div>
@ -60,7 +61,7 @@
 <table class="function_list">
 	<tr>
 	<td class="name" nowrap><a href="#cleaner.unsafe">cleaner.unsafe</a></td>
-	<td class="summary">Enables unsafe methods.</td>
+	<td class="summary">Enables unsafe methods &amp; chat commands.</td>
 	</tr>
 </table>

@ -76,18 +77,25 @@
    <strong>cleaner.unsafe</strong>
    </dt>
    <dd>
-    Enables unsafe methods. </p>

-<p>  <code>cleaner.remove_ore</code>
+<p>Enables unsafe methods &amp; chat commands. </p>
+
+<ul>
+    <li><code>cleaner.remove_ore</code></li>
+    <li><code>/remove_ores</code></li>
+</ul>
+
+
+<p><strong>Definition:</strong></p>
+
+<ul>
+    <li><span style="font-size:80%;"><code>type:</code></span> <code>bool</code></li>
+    <li><span style="font-size:80%;"><code>default:</code></span> <code>false</code></li>
+</ul>
+

    </ul>
-    <h3>Setting Type:</h3>
-    <ul>
-         bool
    </ul>
-    <h3>Default Value:</h3>
-    <ul>
-         false
    </ul>
    </ul>

@ -104,7 +112,7 @@
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
-<i style="float:right;">Last updated 2021-07-29 13:38:35 </i>
+<i style="float:right;">Last updated 2021-07-30 16:16:51 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
--- a/docs/reference/topics/tools.html
+++ b/docs/reference/topics/tools.html
@ -43,6 +43,7 @@
  <li><a href="../topics/api.html">api</a></li>
  <li><a href="../topics/commands.html">commands</a></li>
  <li><strong>tools</strong></li>
+  <li><a href="../topics/config.html">config</a></li>
 </ul>

 </div>
@ -114,7 +115,7 @@ use (left-click):
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
-<i style="float:right;">Last updated 2021-07-29 13:38:35 </i>
+<i style="float:right;">Last updated 2021-07-30 16:16:51 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>