Skip to content

Commit

Permalink
norns doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
@tehn
tehn committed Oct 8, 2024
1 parent e246ce2 commit 6155913
Show file tree
Hide file tree
Showing 55 changed files with 2,783 additions and 1,802 deletions.
57 changes: 30 additions & 27 deletions norns/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ <h1>norns</h1>




<h2>Modules</h2>
<ul class="nowrap">
<li><a href="modules/arc.html">arc</a></li>
Expand All @@ -54,25 +55,25 @@ <h2>Modules</h2>
<li><a href="modules/screen.html">screen</a></li>
<li><a href="modules/script.html">script</a></li>
<li><a href="modules/softcut.html">softcut</a></li>
<li><a href="modules/lib.BeatClock.html">lib.BeatClock</a></li>
<li><a href="modules/lib.beatclock.html">lib.beatclock</a></li>
<li><a href="modules/lib.container.defaulttable.html">lib.container.defaulttable</a></li>
<li><a href="modules/lib.container.deque.html">lib.container.deque</a></li>
<li><a href="modules/lib.container.observable.html">lib.container.observable</a></li>
<li><a href="modules/lib.container.watchtable.html">lib.container.watchtable</a></li>
<li><a href="modules/lib.container.weaktable.html">lib.container.weaktable</a></li>
<li><a href="modules/lib.elca.html">lib.elca</a></li>
<li><a href="modules/lib.EnvGraph.html">lib.EnvGraph</a></li>
<li><a href="modules/lib.envgraph.html">lib.envgraph</a></li>
<li><a href="modules/lib.er.html">lib.er</a></li>
<li><a href="modules/lib.fileselect.html">lib.fileselect</a></li>
<li><a href="modules/lib.FilterGraph.html">lib.FilterGraph</a></li>
<li><a href="modules/lib.filtergraph.html">lib.filtergraph</a></li>
<li><a href="modules/lib.filters.html">lib.filters</a></li>
<li><a href="modules/lib.formatters.html">lib.formatters</a></li>
<li><a href="modules/lib.Graph.html">lib.Graph</a></li>
<li><a href="modules/lib.graph.html">lib.graph</a></li>
<li><a href="modules/lib.intonation.html">lib.intonation</a></li>
<li><a href="modules/Lattice.html">Lattice</a></li>
<li><a href="modules/lib.lattice.html">lib.lattice</a></li>
<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.musicutil.html">lib.musicutil</a></li>
<li><a href="modules/lib.pattern.html">lib.pattern</a></li>
<li><a href="modules/lib.reflection.html">lib.reflection</a></li>
<li><a href="modules/lib.sequins.html">lib.sequins</a></li>
Expand All @@ -81,7 +82,7 @@ <h2>Modules</h2>
<li><a href="modules/lib.textentry.html">lib.textentry</a></li>
<li><a href="modules/lib.textentry_kbd.html">lib.textentry_kbd</a></li>
<li><a href="modules/lib.timeline.html">lib.timeline</a></li>
<li><a href="modules/lib.UI.html">lib.UI</a></li>
<li><a href="modules/lib.ui.html">lib.ui</a></li>
<li><a href="modules/lib.util.html">lib.util</a></li>
<li><a href="modules/lib.voice.html">lib.voice</a></li>
</ul>
Expand Down Expand Up @@ -188,43 +189,44 @@ <h2>Modules</h2>
</tr>
<tr>
<td class="name" nowrap><a href="modules/softcut.html">softcut</a></td>
<td class="summary">Softcut module
<td class="summary">Softcut module</p>

<p> API for controlling the "softcut" buffer processor
includes low-level setters and mid-level utilities
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, &c.</td>
this applies to indices for selecting voice, ADC/DAC channel, buffer, &amp;c.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.BeatClock.html">lib.BeatClock</a></td>
<td class="name" nowrap><a href="modules/lib.beatclock.html">lib.beatclock</a></td>
<td class="summary">BeatClock</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.container.defaulttable.html">lib.container.defaulttable</a></td>
<td class="summary">Create a table where every key is inialized with a default value when first
accessed.</td>
<td class="summary">DefaultTable - a table which provides a default value initialization for each key</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.container.deque.html">lib.container.deque</a></td>
<td class="summary">Create a Deque value (object).</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.container.observable.html">lib.container.observable</a></td>
<td class="summary">Create an Observable value (object).</td>
<td class="summary">observable - an observable value</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.container.watchtable.html">lib.container.watchtable</a></td>
<td class="summary">Create a table which invokes a callback each time a value is set.</td>
<td class="summary">WatchTable - a table which can be watched of key changes</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.container.weaktable.html">lib.container.weaktable</a></td>
<td class="summary">Create a table with weakly held keys</td>
<td class="summary">weaktable - a table with weakly held keys</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.elca.html">lib.elca</a></td>
<td class="summary">elementary cellular automata</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.EnvGraph.html">lib.EnvGraph</a></td>
<td class="name" nowrap><a href="modules/lib.envgraph.html">lib.envgraph</a></td>
<td class="summary">Envelope graph drawing module.</td>
</tr>
<tr>
Expand All @@ -236,7 +238,7 @@ <h2>Modules</h2>
<td class="summary">fileselect utility</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.FilterGraph.html">lib.FilterGraph</a></td>
<td class="name" nowrap><a href="modules/lib.filtergraph.html">lib.filtergraph</a></td>
<td class="summary">Filter graph drawing module.</td>
</tr>
<tr>
Expand All @@ -248,27 +250,27 @@ <h2>Modules</h2>
<td class="summary">Formatters</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.Graph.html">lib.Graph</a></td>
<td class="name" nowrap><a href="modules/lib.graph.html">lib.graph</a></td>
<td class="summary">Graph drawing module.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.intonation.html">lib.intonation</a></td>
<td class="summary">"just" some intonation tables</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/Lattice.html">Lattice</a></td>
<td class="name" nowrap><a href="modules/lib.lattice.html">lib.lattice</a></td>
<td class="summary">module for creating a lattice of sprockets based on a single fast "superclock"</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.lfo.html">lib.lfo</a></td>
<td class="summary">construct an LFO</td>
<td class="summary">LFOs for general-purpose scripting</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.listselect.html">lib.listselect</a></td>
<td class="summary">listselect utility</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.MusicUtil.html">lib.MusicUtil</a></td>
<td class="name" nowrap><a href="modules/lib.musicutil.html">lib.musicutil</a></td>
<td class="summary">Music utility module.</td>
</tr>
<tr>
Expand Down Expand Up @@ -302,11 +304,12 @@ <h2>Modules</h2>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.timeline.html">lib.timeline</a></td>
<td class="summary">timeline sequencer
hotrod some clock & sequins structures for rapid playability</td>
<td class="summary">timeline sequencer</p>

<p> hotrod some clock &amp; sequins structures for rapid playability.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/lib.UI.html">lib.UI</a></td>
<td class="name" nowrap><a href="modules/lib.ui.html">lib.ui</a></td>
<td class="summary">UI widgets module.</td>
</tr>
<tr>
Expand All @@ -322,8 +325,8 @@ <h2>Modules</h2>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2023-11-17 11:40:11 </i>
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-10-08 18:50:59 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
1 change: 1 addition & 0 deletions norns/api/ldoc_pale.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,7 @@ pre .library { color: #0e7c6b; }
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
pre .string { color: #8080ff; }
pre .number { color: #f8660d; }
pre .function-name { color: #60447f; }
pre .operator { color: #2239a8; font-weight: bold; }
pre .preprocessor, pre .prepro { color: #a33243; }
pre .global { color: #800080; }
Expand Down
Loading

0 comments on commit 6155913

Please sign in to comment.