More Lua API doc improvements. (#1801)

* Fix name of module pattern_time in API docs.
* Correct ldoc descriptions for lib.util and softcut.
* Explain lib.beatclock is old.
* Include all param types in API documentation.

doc/index.html

@@ -49,7 +49,16 @@ <h2>Modules</h2>
   <li><a href="modules/midi.html">midi</a></li>
   <li><a href="modules/norns.html">norns</a></li>
   <li><a href="modules/osc.html">osc</a></li>
+  <li><a href="modules/params.binary.html">params.binary</a></li>
   <li><a href="modules/params.control.html">params.control</a></li>
+  <li><a href="modules/params.file.html">params.file</a></li>
+  <li><a href="modules/params.group.html">params.group</a></li>
+  <li><a href="modules/params.number.html">params.number</a></li>
+  <li><a href="modules/params.option.html">params.option</a></li>
+  <li><a href="modules/params.separator.html">params.separator</a></li>
+  <li><a href="modules/params.taper.html">params.taper</a></li>
+  <li><a href="modules/params.text.html">params.text</a></li>
+  <li><a href="modules/params.trigger.html">params.trigger</a></li>
   <li><a href="modules/paramset.html">paramset</a></li>
   <li><a href="modules/poll.html">poll</a></li>
   <li><a href="modules/screen.html">screen</a></li>
@@ -74,7 +83,7 @@ <h2>Modules</h2>
   <li><a href="modules/lib.lfo.html">lib.lfo</a></li>
   <li><a href="modules/lib.listselect.html">lib.listselect</a></li>
   <li><a href="modules/lib.musicutil.html">lib.musicutil</a></li>
-  <li><a href="modules/lib.pattern.html">lib.pattern</a></li>
+  <li><a href="modules/lib.pattern_time.html">lib.pattern_time</a></li>
   <li><a href="modules/lib.reflection.html">lib.reflection</a></li>
   <li><a href="modules/lib.sequins.html">lib.sequins</a></li>
   <li><a href="modules/lib.tabutil.html">lib.tabutil</a></li>
@@ -165,13 +174,49 @@ <h2>Modules</h2>
 		<td class="name"  nowrap><a href="modules/osc.html">osc</a></td>
 		<td class="summary">osc device</td>
 	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/params.binary.html">params.binary</a></td>
+		<td class="summary">Binary (toggling) parameters</td>
+	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/params.control.html">params.control</a></td>
-		<td class="summary">Control class</td>
+		<td class="summary">Parameter with granular control</td>
+	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/params.file.html">params.file</a></td>
+		<td class="summary">An easy way to load files into scripts via parameters</td>
+	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/params.group.html">params.group</a></td>
+		<td class="summary">Groups of parameters</td>
+	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/params.number.html">params.number</a></td>
+		<td class="summary">Defines parameters which require discrete incrementing values</td>
+	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/params.option.html">params.option</a></td>
+		<td class="summary">Select a parameter from a list</td>
+	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/params.separator.html">params.separator</a></td>
+		<td class="summary">Separator between parameters</td>
+	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/params.taper.html">params.taper</a></td>
+		<td class="summary">Non-linear parameter using @catfact's taper function</td>
+	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/params.text.html">params.text</a></td>
+		<td class="summary">Parameter for text entry</td>
+	</tr>
+	<tr>
+		<td class="name"  nowrap><a href="modules/params.trigger.html">params.trigger</a></td>
+		<td class="summary">Parameter for an “on/off” action trigger</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/paramset.html">paramset</a></td>
-		<td class="summary">ParamSet class</td>
+		<td class="summary">Sets of parameters, such as those in the PARAMETERS menu.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/poll.html">poll</a></td>
@@ -189,17 +234,11 @@ <h2>Modules</h2>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/softcut.html">softcut</a></td>
-		<td class="summary">Softcut module</p>
-
-<p> API for controlling the "softcut" buffer processor
- includes low-level setters and mid-level utilities</p>
-
-<p> IMPORTANT: all indices are 1-based, per lua convention!
- this applies to indices for selecting voice, ADC/DAC channel, buffer, &amp;c.</td>
+		<td class="summary">Softcut module.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/lib.beatclock.html">lib.beatclock</a></td>
-		<td class="summary">BeatClock</td>
+		<td class="summary">Older clock library - see <a href="modules/clock.html#">clock</a> instead</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/lib.container.defaulttable.html">lib.container.defaulttable</a></td>
@@ -274,7 +313,7 @@ <h2>Modules</h2>
 		<td class="summary">Music utility module.</td>
 	</tr>
 	<tr>
-		<td class="name"  nowrap><a href="modules/lib.pattern.html">lib.pattern</a></td>
+		<td class="name"  nowrap><a href="modules/lib.pattern_time.html">lib.pattern_time</a></td>
 		<td class="summary">timed pattern event recorder/player</td>
 	</tr>
 	<tr>
@@ -314,7 +353,7 @@ <h2>Modules</h2>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/lib.util.html">lib.util</a></td>
-		<td class="summary">db to amp.</td>
+		<td class="summary">Utility functions.</td>
 	</tr>
 	<tr>
 		<td class="name"  nowrap><a href="modules/lib.voice.html">lib.voice</a></td>
@@ -326,7 +365,7 @@ <h2>Modules</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-10-06 20:11:00 </i>
+<i style="float:right;">Last updated 2024-10-13 17:45:04 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/modules/arc.html

@@ -56,7 +56,16 @@ <h2>Modules</h2>
   <li><a href="../modules/midi.html">midi</a></li>
   <li><a href="../modules/norns.html">norns</a></li>
   <li><a href="../modules/osc.html">osc</a></li>
+  <li><a href="../modules/params.binary.html">params.binary</a></li>
   <li><a href="../modules/params.control.html">params.control</a></li>
+  <li><a href="../modules/params.file.html">params.file</a></li>
+  <li><a href="../modules/params.group.html">params.group</a></li>
+  <li><a href="../modules/params.number.html">params.number</a></li>
+  <li><a href="../modules/params.option.html">params.option</a></li>
+  <li><a href="../modules/params.separator.html">params.separator</a></li>
+  <li><a href="../modules/params.taper.html">params.taper</a></li>
+  <li><a href="../modules/params.text.html">params.text</a></li>
+  <li><a href="../modules/params.trigger.html">params.trigger</a></li>
   <li><a href="../modules/paramset.html">paramset</a></li>
   <li><a href="../modules/poll.html">poll</a></li>
   <li><a href="../modules/screen.html">screen</a></li>
@@ -81,7 +90,7 @@ <h2>Modules</h2>
   <li><a href="../modules/lib.lfo.html">lib.lfo</a></li>
   <li><a href="../modules/lib.listselect.html">lib.listselect</a></li>
   <li><a href="../modules/lib.musicutil.html">lib.musicutil</a></li>
-  <li><a href="../modules/lib.pattern.html">lib.pattern</a></li>
+  <li><a href="../modules/lib.pattern_time.html">lib.pattern_time</a></li>
   <li><a href="../modules/lib.reflection.html">lib.reflection</a></li>
   <li><a href="../modules/lib.sequins.html">lib.sequins</a></li>
   <li><a href="../modules/lib.tabutil.html">lib.tabutil</a></li>
@@ -369,7 +378,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-10-06 20:11:00 </i>
+<i style="float:right;">Last updated 2024-10-13 17:45:04 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/modules/audio.html

@@ -61,7 +61,16 @@ <h2>Modules</h2>
   <li><a href="../modules/midi.html">midi</a></li>
   <li><a href="../modules/norns.html">norns</a></li>
   <li><a href="../modules/osc.html">osc</a></li>
+  <li><a href="../modules/params.binary.html">params.binary</a></li>
   <li><a href="../modules/params.control.html">params.control</a></li>
+  <li><a href="../modules/params.file.html">params.file</a></li>
+  <li><a href="../modules/params.group.html">params.group</a></li>
+  <li><a href="../modules/params.number.html">params.number</a></li>
+  <li><a href="../modules/params.option.html">params.option</a></li>
+  <li><a href="../modules/params.separator.html">params.separator</a></li>
+  <li><a href="../modules/params.taper.html">params.taper</a></li>
+  <li><a href="../modules/params.text.html">params.text</a></li>
+  <li><a href="../modules/params.trigger.html">params.trigger</a></li>
   <li><a href="../modules/paramset.html">paramset</a></li>
   <li><a href="../modules/poll.html">poll</a></li>
   <li><a href="../modules/screen.html">screen</a></li>
@@ -86,7 +95,7 @@ <h2>Modules</h2>
   <li><a href="../modules/lib.lfo.html">lib.lfo</a></li>
   <li><a href="../modules/lib.listselect.html">lib.listselect</a></li>
   <li><a href="../modules/lib.musicutil.html">lib.musicutil</a></li>
-  <li><a href="../modules/lib.pattern.html">lib.pattern</a></li>
+  <li><a href="../modules/lib.pattern_time.html">lib.pattern_time</a></li>
   <li><a href="../modules/lib.reflection.html">lib.reflection</a></li>
   <li><a href="../modules/lib.sequins.html">lib.sequins</a></li>
   <li><a href="../modules/lib.tabutil.html">lib.tabutil</a></li>
@@ -1031,7 +1040,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-10-06 20:11:00 </i>
+<i style="float:right;">Last updated 2024-10-13 17:45:04 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/modules/clock.html

@@ -57,7 +57,16 @@ <h2>Modules</h2>
   <li><a href="../modules/midi.html">midi</a></li>
   <li><a href="../modules/norns.html">norns</a></li>
   <li><a href="../modules/osc.html">osc</a></li>
+  <li><a href="../modules/params.binary.html">params.binary</a></li>
   <li><a href="../modules/params.control.html">params.control</a></li>
+  <li><a href="../modules/params.file.html">params.file</a></li>
+  <li><a href="../modules/params.group.html">params.group</a></li>
+  <li><a href="../modules/params.number.html">params.number</a></li>
+  <li><a href="../modules/params.option.html">params.option</a></li>
+  <li><a href="../modules/params.separator.html">params.separator</a></li>
+  <li><a href="../modules/params.taper.html">params.taper</a></li>
+  <li><a href="../modules/params.text.html">params.text</a></li>
+  <li><a href="../modules/params.trigger.html">params.trigger</a></li>
   <li><a href="../modules/paramset.html">paramset</a></li>
   <li><a href="../modules/poll.html">poll</a></li>
   <li><a href="../modules/screen.html">screen</a></li>
@@ -82,7 +91,7 @@ <h2>Modules</h2>
   <li><a href="../modules/lib.lfo.html">lib.lfo</a></li>
   <li><a href="../modules/lib.listselect.html">lib.listselect</a></li>
   <li><a href="../modules/lib.musicutil.html">lib.musicutil</a></li>
-  <li><a href="../modules/lib.pattern.html">lib.pattern</a></li>
+  <li><a href="../modules/lib.pattern_time.html">lib.pattern_time</a></li>
   <li><a href="../modules/lib.reflection.html">lib.reflection</a></li>
   <li><a href="../modules/lib.sequins.html">lib.sequins</a></li>
   <li><a href="../modules/lib.tabutil.html">lib.tabutil</a></li>
@@ -399,7 +408,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</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-10-06 20:11:00 </i>
+<i style="float:right;">Last updated 2024-10-13 17:45:04 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/modules/controlspec.html

@@ -57,7 +57,16 @@ <h2>Modules</h2>
   <li><a href="../modules/midi.html">midi</a></li>
   <li><a href="../modules/norns.html">norns</a></li>
   <li><a href="../modules/osc.html">osc</a></li>
+  <li><a href="../modules/params.binary.html">params.binary</a></li>
   <li><a href="../modules/params.control.html">params.control</a></li>
+  <li><a href="../modules/params.file.html">params.file</a></li>
+  <li><a href="../modules/params.group.html">params.group</a></li>
+  <li><a href="../modules/params.number.html">params.number</a></li>
+  <li><a href="../modules/params.option.html">params.option</a></li>
+  <li><a href="../modules/params.separator.html">params.separator</a></li>
+  <li><a href="../modules/params.taper.html">params.taper</a></li>
+  <li><a href="../modules/params.text.html">params.text</a></li>
+  <li><a href="../modules/params.trigger.html">params.trigger</a></li>
   <li><a href="../modules/paramset.html">paramset</a></li>
   <li><a href="../modules/poll.html">poll</a></li>
   <li><a href="../modules/screen.html">screen</a></li>
@@ -82,7 +91,7 @@ <h2>Modules</h2>
   <li><a href="../modules/lib.lfo.html">lib.lfo</a></li>
   <li><a href="../modules/lib.listselect.html">lib.listselect</a></li>
   <li><a href="../modules/lib.musicutil.html">lib.musicutil</a></li>
-  <li><a href="../modules/lib.pattern.html">lib.pattern</a></li>
+  <li><a href="../modules/lib.pattern_time.html">lib.pattern_time</a></li>
   <li><a href="../modules/lib.reflection.html">lib.reflection</a></li>
   <li><a href="../modules/lib.sequins.html">lib.sequins</a></li>
   <li><a href="../modules/lib.tabutil.html">lib.tabutil</a></li>
@@ -647,7 +656,7 @@ <h2 class="section-header "><a name="Presets"></a>Presets </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-10-06 20:11:00 </i>
+<i style="float:right;">Last updated 2024-10-13 17:45:04 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/modules/core.crow.public.html

@@ -57,7 +57,16 @@ <h2>Modules</h2>
   <li><a href="../modules/midi.html">midi</a></li>
   <li><a href="../modules/norns.html">norns</a></li>
   <li><a href="../modules/osc.html">osc</a></li>
+  <li><a href="../modules/params.binary.html">params.binary</a></li>
   <li><a href="../modules/params.control.html">params.control</a></li>
+  <li><a href="../modules/params.file.html">params.file</a></li>
+  <li><a href="../modules/params.group.html">params.group</a></li>
+  <li><a href="../modules/params.number.html">params.number</a></li>
+  <li><a href="../modules/params.option.html">params.option</a></li>
+  <li><a href="../modules/params.separator.html">params.separator</a></li>
+  <li><a href="../modules/params.taper.html">params.taper</a></li>
+  <li><a href="../modules/params.text.html">params.text</a></li>
+  <li><a href="../modules/params.trigger.html">params.trigger</a></li>
   <li><a href="../modules/paramset.html">paramset</a></li>
   <li><a href="../modules/poll.html">poll</a></li>
   <li><a href="../modules/screen.html">screen</a></li>
@@ -82,7 +91,7 @@ <h2>Modules</h2>
   <li><a href="../modules/lib.lfo.html">lib.lfo</a></li>
   <li><a href="../modules/lib.listselect.html">lib.listselect</a></li>
   <li><a href="../modules/lib.musicutil.html">lib.musicutil</a></li>
-  <li><a href="../modules/lib.pattern.html">lib.pattern</a></li>
+  <li><a href="../modules/lib.pattern_time.html">lib.pattern_time</a></li>
   <li><a href="../modules/lib.reflection.html">lib.reflection</a></li>
   <li><a href="../modules/lib.sequins.html">lib.sequins</a></li>
   <li><a href="../modules/lib.tabutil.html">lib.tabutil</a></li>
@@ -267,7 +276,7 @@ <h3>Fields:</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-10-06 20:11:00 </i>
+<i style="float:right;">Last updated 2024-10-13 17:45:04 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/modules/core.crow.quote.html

@@ -52,7 +52,16 @@ <h2>Modules</h2>
   <li><a href="../modules/midi.html">midi</a></li>
   <li><a href="../modules/norns.html">norns</a></li>
   <li><a href="../modules/osc.html">osc</a></li>
+  <li><a href="../modules/params.binary.html">params.binary</a></li>
   <li><a href="../modules/params.control.html">params.control</a></li>
+  <li><a href="../modules/params.file.html">params.file</a></li>
+  <li><a href="../modules/params.group.html">params.group</a></li>
+  <li><a href="../modules/params.number.html">params.number</a></li>
+  <li><a href="../modules/params.option.html">params.option</a></li>
+  <li><a href="../modules/params.separator.html">params.separator</a></li>
+  <li><a href="../modules/params.taper.html">params.taper</a></li>
+  <li><a href="../modules/params.text.html">params.text</a></li>
+  <li><a href="../modules/params.trigger.html">params.trigger</a></li>
   <li><a href="../modules/paramset.html">paramset</a></li>
   <li><a href="../modules/poll.html">poll</a></li>
   <li><a href="../modules/screen.html">screen</a></li>
@@ -77,7 +86,7 @@ <h2>Modules</h2>
   <li><a href="../modules/lib.lfo.html">lib.lfo</a></li>
   <li><a href="../modules/lib.listselect.html">lib.listselect</a></li>
   <li><a href="../modules/lib.musicutil.html">lib.musicutil</a></li>
-  <li><a href="../modules/lib.pattern.html">lib.pattern</a></li>
+  <li><a href="../modules/lib.pattern_time.html">lib.pattern_time</a></li>
   <li><a href="../modules/lib.reflection.html">lib.reflection</a></li>
   <li><a href="../modules/lib.sequins.html">lib.sequins</a></li>
   <li><a href="../modules/lib.tabutil.html">lib.tabutil</a></li>
@@ -114,7 +123,7 @@ <h1>Module <code>core.crow.quote</code></h1>
 </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-10-06 20:11:00 </i>
+<i style="float:right;">Last updated 2024-10-13 17:45:04 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

doc/modules/crow.html

@@ -57,7 +57,16 @@ <h2>Modules</h2>
   <li><a href="../modules/midi.html">midi</a></li>
   <li><a href="../modules/norns.html">norns</a></li>
   <li><a href="../modules/osc.html">osc</a></li>
+  <li><a href="../modules/params.binary.html">params.binary</a></li>
   <li><a href="../modules/params.control.html">params.control</a></li>
+  <li><a href="../modules/params.file.html">params.file</a></li>
+  <li><a href="../modules/params.group.html">params.group</a></li>
+  <li><a href="../modules/params.number.html">params.number</a></li>
+  <li><a href="../modules/params.option.html">params.option</a></li>
+  <li><a href="../modules/params.separator.html">params.separator</a></li>
+  <li><a href="../modules/params.taper.html">params.taper</a></li>
+  <li><a href="../modules/params.text.html">params.text</a></li>
+  <li><a href="../modules/params.trigger.html">params.trigger</a></li>
   <li><a href="../modules/paramset.html">paramset</a></li>
   <li><a href="../modules/poll.html">poll</a></li>
   <li><a href="../modules/screen.html">screen</a></li>
@@ -82,7 +91,7 @@ <h2>Modules</h2>
   <li><a href="../modules/lib.lfo.html">lib.lfo</a></li>
   <li><a href="../modules/lib.listselect.html">lib.listselect</a></li>
   <li><a href="../modules/lib.musicutil.html">lib.musicutil</a></li>
-  <li><a href="../modules/lib.pattern.html">lib.pattern</a></li>
+  <li><a href="../modules/lib.pattern_time.html">lib.pattern_time</a></li>
   <li><a href="../modules/lib.reflection.html">lib.reflection</a></li>
   <li><a href="../modules/lib.sequins.html">lib.sequins</a></li>
   <li><a href="../modules/lib.tabutil.html">lib.tabutil</a></li>
@@ -215,7 +224,7 @@ <h3>Fields:</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-10-06 20:11:00 </i>
+<i style="float:right;">Last updated 2024-10-13 17:45:04 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>