Generate HTML documentation with LDoc

This commit is contained in:
Jordan Irwin 2021-05-08 21:18:58 -07:00
parent 2210eff6bc
commit d992f38268
2 changed files with 791 additions and 0 deletions

488
docs/api.html Normal file

@ -0,0 +1,488 @@
<!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>Sneeker 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>sneeker</h1>
<h2>Contents</h2>
<ul>
<li><a href="#Settings">Settings</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><strong>settings.lua</strong></li>
</ul>
</div>
<div id="content">
<h1>Module <code>settings.lua</code></h1>
<p>Settings for sneeker mod.</p>
<p>
</p>
<h2><a href="#Settings">Settings</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#sneeker.lifespan">sneeker.lifespan</a></td>
<td class="summary">How long (in seconds) sneeker remains in world after spawn.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sneeker.boom_gain">sneeker.boom_gain</a></td>
<td class="summary">Loudness of explosion.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sneeker.spawn_require_player_nearby">sneeker.spawn_require_player_nearby</a></td>
<td class="summary">Determines whether or not a player must be close for spawn to occur.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sneeker.spawn_player_radius">sneeker.spawn_player_radius</a></td>
<td class="summary">Distance in nodes a player must be for spawn to occur.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sneeker.despawn_player_far">sneeker.despawn_player_far</a></td>
<td class="summary">If enabled, mobs not near any players will despawn.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sneeker.despawn_player_radius">sneeker.despawn_player_radius</a></td>
<td class="summary">Distance determining if a player is near enough to prevent despawn.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sneeker.spawn_chance">sneeker.spawn_chance</a></td>
<td class="summary">Sets possibility for spawn.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sneeker.spawn_interval">sneeker.spawn_interval</a></td>
<td class="summary">Sets frequency of spawn chance.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sneeker.spawn_minlight">sneeker.spawn_minlight</a></td>
<td class="summary">Sets the minimum light that a node must have for spawn to occur.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sneeker.spawn_maxlight">sneeker.spawn_maxlight</a></td>
<td class="summary">Sets the maximum light that a node can have for spawn to occur.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sneeker.spawn_minheight">sneeker.spawn_minheight</a></td>
<td class="summary">Sets the lowest position at which sneeker can spawn.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sneeker.spawn_maxheight">sneeker.spawn_maxheight</a></td>
<td class="summary">Sets the highest position at which sneeker can spawn.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sneeker.spawn_mapblock_limit">sneeker.spawn_mapblock_limit</a></td>
<td class="summary">Limits the number of entities that can spawn per mapblock (16x16x16).</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Settings"></a>Settings</h2>
<dl class="function">
<dt>
<a name = "sneeker.lifespan"></a>
<strong>sneeker.lifespan</strong>
</dt>
<dd>
How long (in seconds) sneeker remains in world after spawn.
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>int</i>
</ul>
<h3>Default:</h3>
<ul>
<i>900 (15 minutes)</i>
</ul>
</ul>
</dd>
<dt>
<a name = "sneeker.boom_gain"></a>
<strong>sneeker.boom_gain</strong>
</dt>
<dd>
Loudness of explosion.
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>float</i>
</ul>
<h3>Default:</h3>
<ul>
<i>1.5</i>
</ul>
</ul>
</dd>
<dt>
<a name = "sneeker.spawn_require_player_nearby"></a>
<strong>sneeker.spawn_require_player_nearby</strong>
</dt>
<dd>
Determines whether or not a player must be close for spawn to occur.
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>bool</i>
</ul>
<h3>Default:</h3>
<ul>
<i>true</i>
</ul>
</ul>
</dd>
<dt>
<a name = "sneeker.spawn_player_radius"></a>
<strong>sneeker.spawn_player_radius</strong>
</dt>
<dd>
Distance in nodes a player must be for spawn to occur. </p>
<p> Only used if <a href="api.html#sneeker.spawn_require_player_nearby">sneeker.spawn_require_player_nearby</a> enabled.
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>int</i>
</ul>
<h3>Default:</h3>
<ul>
<i>100</i>
</ul>
</ul>
</dd>
<dt>
<a name = "sneeker.despawn_player_far"></a>
<strong>sneeker.despawn_player_far</strong>
</dt>
<dd>
If enabled, mobs not near any players will despawn.
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>bool</i>
</ul>
<h3>Default:</h3>
<ul>
<i>true</i>
</ul>
</ul>
</dd>
<dt>
<a name = "sneeker.despawn_player_radius"></a>
<strong>sneeker.despawn_player_radius</strong>
</dt>
<dd>
Distance determining if a player is near enough to prevent despawn. </p>
<p> Only used if <a href="api.html#sneeker.despawn_player_far">sneeker.despawn_player_far</a> enabled.
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>int</i>
</ul>
<h3>Default:</h3>
<ul>
<i>500</i>
</ul>
</ul>
</dd>
<dt>
<a name = "sneeker.spawn_chance"></a>
<strong>sneeker.spawn_chance</strong>
</dt>
<dd>
Sets possibility for spawn. </p>
<p> Inverted value (e.g. 10000 = 1/10000).
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>int</i>
</ul>
<h3>Default:</h3>
<ul>
<i>10000</i>
</ul>
</ul>
</dd>
<dt>
<a name = "sneeker.spawn_interval"></a>
<strong>sneeker.spawn_interval</strong>
</dt>
<dd>
Sets frequency of spawn chance.
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>int</i>
</ul>
<h3>Default:</h3>
<ul>
<i>240 (4 minutes)</i>
</ul>
</ul>
</dd>
<dt>
<a name = "sneeker.spawn_minlight"></a>
<strong>sneeker.spawn_minlight</strong>
</dt>
<dd>
Sets the minimum light that a node must have for spawn to occur. </p>
<p> Value can be set between 0 (no light) &amp; 15 (max light).
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>int</i>
</ul>
<h3>Default:</h3>
<ul>
<i>0</i>
</ul>
</ul>
</dd>
<dt>
<a name = "sneeker.spawn_maxlight"></a>
<strong>sneeker.spawn_maxlight</strong>
</dt>
<dd>
Sets the maximum light that a node can have for spawn to occur. </p>
<p> Value can be set between 0 (no light) &amp; 15 (max light).
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>int</i>
</ul>
<h3>Default:</h3>
<ul>
<i>4</i>
</ul>
</ul>
</dd>
<dt>
<a name = "sneeker.spawn_minheight"></a>
<strong>sneeker.spawn_minheight</strong>
</dt>
<dd>
Sets the lowest position at which sneeker can spawn.
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>int</i>
</ul>
<h3>Default:</h3>
<ul>
<i>-31000</i>
</ul>
</ul>
</dd>
<dt>
<a name = "sneeker.spawn_maxheight"></a>
<strong>sneeker.spawn_maxheight</strong>
</dt>
<dd>
Sets the highest position at which sneeker can spawn.
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>int</i>
</ul>
<h3>Default:</h3>
<ul>
<i>31000</i>
</ul>
</ul>
</dd>
<dt>
<a name = "sneeker.spawn_mapblock_limit"></a>
<strong>sneeker.spawn_mapblock_limit</strong>
</dt>
<dd>
Limits the number of entities that can spawn per mapblock (16x16x16).
</ul>
</ul>
</ul>
</ul>
<h3>Type:</h3>
<ul>
<i>int</i>
</ul>
<h3>Default:</h3>
<ul>
<i>1</i>
</ul>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/AntumDeluge/LDoc">LDoc 1.4.6-antum-2</a></i>
<i style="float:right;">Last updated 2021-05-08 21:15:42 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

303
docs/ldoc.css Normal file

@ -0,0 +1,303 @@
/* BEGIN RESET
Copyright (c) 2010, Yahoo! Inc. All rights reserved.
Code licensed under the BSD License:
http://developer.yahoo.com/yui/license.html
version: 2.8.2r1
*/
html {
color: #000;
background: #FFF;
}
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
margin: 0;
padding: 0;
}
table {
border-collapse: collapse;
border-spacing: 0;
}
fieldset,img {
border: 0;
}
address,caption,cite,code,dfn,em,strong,th,var,optgroup {
font-style: inherit;
font-weight: inherit;
}
del,ins {
text-decoration: none;
}
li {
margin-left: 20px;
}
caption,th {
text-align: left;
}
h1,h2,h3,h4,h5,h6 {
font-size: 100%;
font-weight: bold;
}
q:before,q:after {
content: '';
}
abbr,acronym {
border: 0;
font-variant: normal;
}
sup {
vertical-align: baseline;
}
sub {
vertical-align: baseline;
}
legend {
color: #000;
}
input,button,textarea,select,optgroup,option {
font-family: inherit;
font-size: inherit;
font-style: inherit;
font-weight: inherit;
}
input,button,textarea,select {*font-size:100%;
}
/* END RESET */
body {
margin-left: 1em;
margin-right: 1em;
font-family: arial, helvetica, geneva, sans-serif;
background-color: #ffffff; margin: 0px;
}
code, tt { font-family: monospace; font-size: 1.1em; }
span.parameter { font-family:monospace; }
span.parameter:after { content:":"; }
span.types:before { content:"("; }
span.types:after { content:")"; }
.type { font-weight: bold; font-style:italic }
body, p, td, th { font-size: .95em; line-height: 1.2em;}
p, ul { margin: 10px 0 0 0px;}
strong { font-weight: bold;}
em { font-style: italic;}
h1 {
font-size: 1.5em;
margin: 20px 0 20px 0;
}
h2, h3, h4 { margin: 15px 0 10px 0; }
h2 { font-size: 1.25em; }
h3 { font-size: 1.15em; }
h4 { font-size: 1.06em; }
a:link { font-weight: bold; color: #004080; text-decoration: none; }
a:visited { font-weight: bold; color: #006699; text-decoration: none; }
a:link:hover { text-decoration: underline; }
hr {
color:#cccccc;
background: #00007f;
height: 1px;
}
blockquote { margin-left: 3em; }
ul { list-style-type: disc; }
p.name {
font-family: "Andale Mono", monospace;
padding-top: 1em;
}
pre {
background-color: rgb(245, 245, 245);
border: 1px solid #C0C0C0; /* silver */
padding: 10px;
margin: 10px 0 10px 0;
overflow: auto;
font-family: "Andale Mono", monospace;
}
pre.example {
font-size: .85em;
}
table.index { border: 1px #00007f; }
table.index td { text-align: left; vertical-align: top; }
#container {
margin-left: 1em;
margin-right: 1em;
background-color: #f0f0f0;
}
#product {
text-align: center;
border-bottom: 1px solid #cccccc;
background-color: #ffffff;
}
#product big {
font-size: 2em;
}
#main {
background-color: #f0f0f0;
border-left: 2px solid #cccccc;
}
#navigation {
float: left;
width: 14em;
vertical-align: top;
background-color: #f0f0f0;
overflow: visible;
}
#navigation h2 {
background-color:#e7e7e7;
font-size:1.1em;
color:#000000;
text-align: left;
padding:0.2em;
border-top:1px solid #dddddd;
border-bottom:1px solid #dddddd;
}
#navigation ul
{
font-size:1em;
list-style-type: none;
margin: 1px 1px 10px 1px;
}
#navigation li {
text-indent: -1em;
display: block;
margin: 3px 0px 0px 22px;
}
#navigation li li a {
margin: 0px 3px 0px -1em;
}
#content {
margin-left: 14em;
padding: 1em;
width: 700px;
border-left: 2px solid #cccccc;
border-right: 2px solid #cccccc;
background-color: #ffffff;
}
#about {
clear: both;
padding: 5px;
border-top: 2px solid #cccccc;
background-color: #ffffff;
}
@media print {
body {
font: 12pt "Times New Roman", "TimeNR", Times, serif;
}
a { font-weight: bold; color: #004080; text-decoration: underline; }
#main {
background-color: #ffffff;
border-left: 0px;
}
#container {
margin-left: 2%;
margin-right: 2%;
background-color: #ffffff;
}
#content {
padding: 1em;
background-color: #ffffff;
}
#navigation {
display: none;
}
pre.example {
font-family: "Andale Mono", monospace;
font-size: 10pt;
page-break-inside: avoid;
}
}
table.module_list {
border-width: 1px;
border-style: solid;
border-color: #cccccc;
border-collapse: collapse;
}
table.module_list td {
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
}
table.module_list td.name { background-color: #f0f0f0; min-width: 200px; }
table.module_list td.summary { width: 100%; }
table.function_list {
border-width: 1px;
border-style: solid;
border-color: #cccccc;
border-collapse: collapse;
}
table.function_list td {
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
}
table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
table.function_list td.summary { width: 100%; }
ul.nowrap {
overflow:auto;
white-space:nowrap;
}
dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
dl.table h3, dl.function h3 {font-size: .95em;}
/* stop sublists from having initial vertical space */
ul ul { margin-top: 0px; }
ol ul { margin-top: 0px; }
ol ol { margin-top: 0px; }
ul ol { margin-top: 0px; }
/* make the target distinct; helps when we're navigating to a function */
a:target + * {
background-color: #FF9;
}
/* styles for prettification of source */
pre .comment { color: #558817; }
pre .constant { color: #a8660d; }
pre .escape { color: #844631; }
pre .keyword { color: #aa5050; font-weight: bold; }
pre .library { color: #0e7c6b; }
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
pre .string { color: #8080ff; }
pre .number { color: #f8660d; }
pre .operator { color: #2239a8; font-weight: bold; }
pre .preprocessor, pre .prepro { color: #a33243; }
pre .global { color: #800080; }
pre .user-keyword { color: #800080; }
pre .prompt { color: #558817; }
pre .url { color: #272fc2; text-decoration: underline; }