Update/add function ldoc comments

Author: sparr

doc/examples/snippets.p8.html

@@ -89,7 +89,7 @@ <h2>snippets.p8</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-09-08 00:27:21 </i>
+<i style="float:right;">Last updated 2024-09-08 02:54:25 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/examples/test_class.p8.html

@@ -129,7 +129,7 @@ <h2>test_class.p8</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-09-08 00:27:21 </i>
+<i style="float:right;">Last updated 2024-09-08 02:54:25 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/examples/test_functions.p8.html

@@ -198,7 +198,7 @@ <h2>test_functions.p8</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-09-08 00:27:21 </i>
+<i style="float:right;">Last updated 2024-09-08 02:54:25 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/examples/test_json.p8.html

@@ -150,7 +150,7 @@ <h2>test_json.p8</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-09-08 00:27:21 </i>
+<i style="float:right;">Last updated 2024-09-08 02:54:25 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/examples/test_test.p8.html

@@ -218,7 +218,7 @@ <h2>test_test.p8</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-09-08 00:27:21 </i>
+<i style="float:right;">Last updated 2024-09-08 02:54:25 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/index.html

@@ -80,7 +80,11 @@ <h2>Modules</h2>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/pico8lib.graphics.html">pico8lib.graphics</a></td>
-		<td class="summary">Drawing and sprite manipulation</td>
+		<td class="summary">Drawing and sprite manipulation</p>
+
+<p> Any function with a color parameter can add the following line
+ to make the color optional and use the pen color by default:
+ <code>c = c or peek(24357) &amp; 15</code></td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/pico8lib.json.html">pico8lib.json</a></td>
@@ -104,7 +108,7 @@ <h2>Modules</h2>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/pico8lib.physics.html">pico8lib.physics</a></td>
-		<td class="summary">check for collision/overlap of a point and a circle
+		<td class="summary">Check for collision/overlap of a point and a circle
  44 tokens</td>
 	</tr>
 	<tr>
@@ -120,7 +124,7 @@ <h2>Modules</h2>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/pico8lib.tables.html">pico8lib.tables</a></td>
-		<td class="summary">Get value from table by key, with default</td>
+		<td class="summary">_</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/pico8lib.test.html">pico8lib.test</a></td>
@@ -135,11 +139,9 @@ <h2>Modules</h2>
 	<tr>
 		<td class="name"  nowrap><a href="modules/pico8lib.vector.html">pico8lib.vector</a></td>
 		<td class="summary">pico8lib vector library
- a vector is a point or direction in 2d space
+ A vector is a point or direction in 2d space
  represented by an x and y coordinate
- vectors arithmetic represents operations on these points/directions
- some code from https://github.com/codekitchen/pico-8-circuits
- MIT license, details in LICENSE file</td>
+ vectors arithmetic represents operations on these points/directions</td>
 	</tr>
 </table>
 <h2>Topics</h2>
@@ -177,7 +179,7 @@ <h2>Examples</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-09-08 00:27:21 </i>
+<i style="float:right;">Last updated 2024-09-08 02:54:25 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/modules/pico8lib.class.html

@@ -133,7 +133,7 @@ <h3>Returns:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-09-08 00:27:21 </i>
+<i style="float:right;">Last updated 2024-09-08 02:54:25 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/modules/pico8lib.functions.html

@@ -87,27 +87,15 @@ <h2><a href="#Local_Functions">Local Functions</a></h2>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#error">error ([m])</a></td>
-	<td class="summary">Raises an error with the given message</td>
+	<td class="summary">Raise an error with the given message</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#memoize">memoize (f)</a></td>
-	<td class="summary">create a memoized version of a single parameter function
- originally from https://www.lua.org/gems/</td>
+	<td class="summary">Create a memoized version of a single parameter function</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#try">try (t, c[, f])</a></td>
-	<td class="summary">
-<p>try/catch/finally implemented with coroutine return codes
- from https://www.lexaloffle.com/bbs/?pid=72820
- "enjoy, and if you like it feel free to kick a buck to my patreon."
- https://www.patreon.com/sharkhugseniko
- example:
-  try(
-   function()</p>
-<pre><code>print("good")
-print("bad" ..
-</code></pre>
-</td>
+	<td class="summary">try/catch/finally implemented using coroutine return codes</td>
 	</tr>
 </table>
 
@@ -127,11 +115,6 @@ <h2 class="section-header "><a name="Local_Functions"></a>Local Functions</h2>
 
 
 
-    <h3>Returns:</h3>
-    <ol>
-
-        null
-    </ol>
 
 
 
@@ -142,7 +125,7 @@ <h3>Returns:</h3>
     <strong>error ([m])</strong>
     </dt>
     <dd>
-    Raises an error with the given message
+    Raise an error with the given message
 
 
     <h3>Parameters:</h3>
@@ -154,11 +137,6 @@ <h3>Parameters:</h3>
         </li>
     </ul>
 
-    <h3>Returns:</h3>
-    <ol>
-
-        null
-    </ol>
 
 
 
@@ -169,8 +147,7 @@ <h3>Returns:</h3>
     <strong>memoize (f)</strong>
     </dt>
     <dd>
-    create a memoized version of a single parameter function
- originally from https://www.lua.org/gems/
+    Create a memoized version of a single parameter function
 
 
     <h3>Parameters:</h3>
@@ -197,26 +174,7 @@ <h3>Returns:</h3>
     <strong>try (t, c[, f])</strong>
     </dt>
     <dd>
-    try/catch/finally implemented with coroutine return codes
- from https://www.lexaloffle.com/bbs/?pid=72820
- "enjoy, and if you like it feel free to kick a buck to my patreon."
- https://www.patreon.com/sharkhugseniko
- example:
-  try(
-   function()</p>
-<pre><code>print("good")
-print("bad" ..  nil)
-</code></pre>
-<p>   end,
-   function(e)</p>
-<pre><code>print("an error occurred:\n" .. e)
-</code></pre>
-<p>   end,
-   function()</p>
-<pre><code>print("finally")
-</code></pre>
-<p>   end
-  )
+    try/catch/finally implemented using coroutine return codes
 
 
     <h3>Parameters:</h3>
@@ -248,7 +206,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2024-09-08 00:27:21 </i>
+<i style="float:right;">Last updated 2024-09-08 02:54:25 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>