Skip to content

Commit

Permalink
Documentation Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 16, 2023
1 parent f39e5ea commit 697fc8b
Showing 63 changed files with 121 additions and 62 deletions.
2 changes: 1 addition & 1 deletion api/index.html
Original file line number Diff line number Diff line change
@@ -410,7 +410,7 @@ <h2>Modules</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/ai.html
Original file line number Diff line number Diff line change
@@ -2488,7 +2488,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/asteroid.html
Original file line number Diff line number Diff line change
@@ -722,7 +722,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/audio.html
Original file line number Diff line number Diff line change
@@ -1217,7 +1217,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/bkg.html
Original file line number Diff line number Diff line change
@@ -272,7 +272,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/camera.html
Original file line number Diff line number Diff line change
@@ -380,7 +380,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/canvas.html
Original file line number Diff line number Diff line change
@@ -383,7 +383,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/cinema.html
Original file line number Diff line number Diff line change
@@ -239,7 +239,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/colour.html
Original file line number Diff line number Diff line change
@@ -619,7 +619,7 @@ <h2><a name="Fields"></a>Fields</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/commodity.html
Original file line number Diff line number Diff line change
@@ -739,7 +739,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/data.html
Original file line number Diff line number Diff line change
@@ -537,7 +537,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/diff.html
Original file line number Diff line number Diff line change
@@ -265,7 +265,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/equipopt.optimize.html
Original file line number Diff line number Diff line change
@@ -218,7 +218,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/escort.html
Original file line number Diff line number Diff line change
@@ -389,7 +389,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/evt.html
Original file line number Diff line number Diff line change
@@ -376,7 +376,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/faction.html
Original file line number Diff line number Diff line change
@@ -1202,7 +1202,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/file.html
Original file line number Diff line number Diff line change
@@ -689,7 +689,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/fleet.html
Original file line number Diff line number Diff line change
@@ -230,7 +230,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/font.html
Original file line number Diff line number Diff line change
@@ -409,7 +409,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/format.html
Original file line number Diff line number Diff line change
@@ -495,7 +495,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/gfx.html
Original file line number Diff line number Diff line change
@@ -1217,7 +1217,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/gui.html
Original file line number Diff line number Diff line change
@@ -578,7 +578,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/hook.html
Original file line number Diff line number Diff line change
@@ -1667,7 +1667,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/jump.html
Original file line number Diff line number Diff line change
@@ -658,7 +658,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/lazyload.html
Original file line number Diff line number Diff line change
@@ -214,7 +214,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/linenoise.html
Original file line number Diff line number Diff line change
@@ -338,7 +338,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/linopt.html
Original file line number Diff line number Diff line change
@@ -611,7 +611,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/lmisn.html
Original file line number Diff line number Diff line change
@@ -792,7 +792,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/lmusic.html
Original file line number Diff line number Diff line change
@@ -252,7 +252,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/love_shaders.html
Original file line number Diff line number Diff line change
@@ -624,7 +624,7 @@ <h2><a name="Fields"></a>Fields</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/misn.html
Original file line number Diff line number Diff line change
@@ -881,7 +881,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/munition.html
Original file line number Diff line number Diff line change
@@ -620,7 +620,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/music.html
Original file line number Diff line number Diff line change
@@ -365,7 +365,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
61 changes: 60 additions & 1 deletion api/modules/naev.html
Original file line number Diff line number Diff line change
@@ -290,6 +290,14 @@ <h2><a href="#Functions">Functions</a></h2>
<td class="summary">Enables or disables text inputting.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#unit">unit ([string=nil])</a></td>
<td class="summary">Gets the translated string corresponding to an in-game unit.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#quadtreeParams">quadtreeParams (max_elem, depth)</a></td>
<td class="summary">Modifies the Naev internal quadtree lookup parameters.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#envs">envs ()</a></td>
<td class="summary">Gets a table with all the active Naev environments.</td>
</tr>
@@ -1147,6 +1155,57 @@ <h3>Parameters:</h3>



</dd>
<dt>
<a name = "unit"></a>
<strong>unit ([string=nil])</strong>
</dt>
<dd>
Gets the translated string corresponding to an in-game unit.


<h3>Parameters:</h3>
<ul>
<li><span class="parameter">string</span>
str Name of the unit to get or nil to get a table with all of them.
(<em>default</em> nil)
</li>
</ul>

<h3>Returns:</h3>
<ol>

Translated string corresponding to the unit or table of all strings if no parameter is passed.
</ol>




</dd>
<dt>
<a name = "quadtreeParams"></a>
<strong>quadtreeParams (max_elem, depth)</strong>
</dt>
<dd>
Modifies the Naev internal quadtree lookup parameters.


<h3>Parameters:</h3>
<ul>
<li><span class="parameter">max_elem</span>
<span class="types"><span class="type">number</span></span>
Maximum amount of elements to allow in a leaf node.
</li>
<li><span class="parameter">depth</span>
<span class="types"><span class="type">number</span></span>
depth Maximum depth to allow.
</li>
</ul>





</dd>
<dt>
<a name = "envs"></a>
@@ -1177,7 +1236,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/news.html
Original file line number Diff line number Diff line change
@@ -497,7 +497,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
2 changes: 1 addition & 1 deletion api/modules/outfit.html
Original file line number Diff line number Diff line change
@@ -1190,7 +1190,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-12-16 03:17:48 </i>
<i style="float:right;">Last updated 2023-12-16 08:10:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<div class="container-fluid nebula-bg mt-5">
Loading

0 comments on commit 697fc8b

Please sign in to comment.