Skip to content

Commit

Permalink
doc update (#457)
Browse files Browse the repository at this point in the history
  • Loading branch information
tehn authored Jul 6, 2018
1 parent aa84df0 commit 20d3eaf
Show file tree
Hide file tree
Showing 26 changed files with 1,343 additions and 128 deletions.
51 changes: 36 additions & 15 deletions doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,27 +32,31 @@ <h1>norns</h1>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="modules/audio.html">audio</a></li>
<li><a href="modules/paramset.html">paramset</a></li>
<li><a href="modules/controlspec.html">controlspec</a></li>
<li><a href="modules/encoders.html">encoders</a></li>
<li><a href="modules/engine.html">engine</a></li>
<li><a href="modules/number.html">number</a></li>
<li><a href="modules/grid.html">grid</a></li>
<li><a href="modules/hid.html">hid</a></li>
<li><a href="modules/log.html">log</a></li>
<li><a href="modules/menu.html">menu</a></li>
<li><a href="modules/metro.html">metro</a></li>
<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/paramset.html">paramset</a></li>
<li><a href="modules/number.html">number</a></li>
<li><a href="modules/number.html">number</a></li>
<li><a href="modules/option.html">option</a></li>
<li><a href="modules/osc.html">osc</a></li>
<li><a href="modules/separator.html">separator</a></li>
<li><a href="modules/taper.html">taper</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>
<li><a href="modules/script.html">script</a></li>
<li><a href="modules/state.html">state</a></li>
<li><a href="modules/tabutil.html">tabutil</a></li>
<li><a href="modules/textentry.html">textentry</a></li>
<li><a href="modules/update.html">update</a></li>
<li><a href="modules/util.html">util</a></li>
</ul>

Expand All @@ -68,10 +72,6 @@ <h2>Modules</h2>
<td class="name" nowrap><a href="modules/audio.html">audio</a></td>
<td class="summary">Audio class</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/paramset.html">paramset</a></td>
<td class="summary">Control class</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/controlspec.html">controlspec</a></td>
<td class="summary">Controlspec Class</td>
Expand All @@ -84,10 +84,6 @@ <h2>Modules</h2>
<td class="name" nowrap><a href="modules/engine.html">engine</a></td>
<td class="summary">Engine class</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/number.html">number</a></td>
<td class="summary">File class</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/grid.html">grid</a></td>
<td class="summary">Grid class</td>
Expand All @@ -100,6 +96,10 @@ <h2>Modules</h2>
<td class="name" nowrap><a href="modules/log.html">log</a></td>
<td class="summary">Log class</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/menu.html">menu</a></td>
<td class="summary">MIX</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/metro.html">metro</a></td>
<td class="summary">high-resolution metro API</td>
Expand All @@ -113,6 +113,18 @@ <h2>Modules</h2>
<td class="summary">norns.lua
main norns script.</td>
</tr>
<tr>
<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/paramset.html">paramset</a></td>
<td class="summary">Control class</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/number.html">number</a></td>
<td class="summary">File class</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/number.html">number</a></td>
<td class="summary">Number class</td>
Expand All @@ -122,8 +134,13 @@ <h2>Modules</h2>
<td class="summary">Option class</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/osc.html">osc</a></td>
<td class="summary">osc device</td>
<td class="name" nowrap><a href="modules/separator.html">separator</a></td>
<td class="summary">Separator class</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/taper.html">taper</a></td>
<td class="summary">Taper class
non-linear parameter using @catfact's taper function</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/paramset.html">paramset</a></td>
Expand Down Expand Up @@ -155,17 +172,21 @@ <h2>Modules</h2>
<td class="name" nowrap><a href="modules/textentry.html">textentry</a></td>
<td class="summary">te class</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/update.html">update</a></td>
<td class="summary">system update functions</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/util.html">util</a></td>
<td class="summary">Utility module;</td>
<td class="summary">Utility module</td>
</tr>
</table>

</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 2018-04-23 17:20:49 </i>
<i style="float:right;">Last updated 2018-07-07 03:32:57 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
12 changes: 8 additions & 4 deletions doc/modules/audio.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,27 +41,31 @@ <h2>Contents</h2>
<h2>Modules</h2>
<ul class="nowrap">
<li><strong>audio</strong></li>
<li><a href="../modules/paramset.html">paramset</a></li>
<li><a href="../modules/controlspec.html">controlspec</a></li>
<li><a href="../modules/encoders.html">encoders</a></li>
<li><a href="../modules/engine.html">engine</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/grid.html">grid</a></li>
<li><a href="../modules/hid.html">hid</a></li>
<li><a href="../modules/log.html">log</a></li>
<li><a href="../modules/menu.html">menu</a></li>
<li><a href="../modules/metro.html">metro</a></li>
<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/paramset.html">paramset</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/option.html">option</a></li>
<li><a href="../modules/osc.html">osc</a></li>
<li><a href="../modules/separator.html">separator</a></li>
<li><a href="../modules/taper.html">taper</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>
<li><a href="../modules/script.html">script</a></li>
<li><a href="../modules/state.html">state</a></li>
<li><a href="../modules/tabutil.html">tabutil</a></li>
<li><a href="../modules/textentry.html">textentry</a></li>
<li><a href="../modules/update.html">update</a></li>
<li><a href="../modules/util.html">util</a></li>
</ul>

Expand Down Expand Up @@ -370,7 +374,7 @@ <h3>Parameters:</h3>
</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 2018-04-23 17:20:49 </i>
<i style="float:right;">Last updated 2018-07-07 03:32:57 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
12 changes: 8 additions & 4 deletions doc/modules/controlspec.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,27 +35,31 @@ <h1>norns</h1>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/audio.html">audio</a></li>
<li><a href="../modules/paramset.html">paramset</a></li>
<li><strong>controlspec</strong></li>
<li><a href="../modules/encoders.html">encoders</a></li>
<li><a href="../modules/engine.html">engine</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/grid.html">grid</a></li>
<li><a href="../modules/hid.html">hid</a></li>
<li><a href="../modules/log.html">log</a></li>
<li><a href="../modules/menu.html">menu</a></li>
<li><a href="../modules/metro.html">metro</a></li>
<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/paramset.html">paramset</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/option.html">option</a></li>
<li><a href="../modules/osc.html">osc</a></li>
<li><a href="../modules/separator.html">separator</a></li>
<li><a href="../modules/taper.html">taper</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>
<li><a href="../modules/script.html">script</a></li>
<li><a href="../modules/state.html">state</a></li>
<li><a href="../modules/tabutil.html">tabutil</a></li>
<li><a href="../modules/textentry.html">textentry</a></li>
<li><a href="../modules/update.html">update</a></li>
<li><a href="../modules/util.html">util</a></li>
</ul>

Expand All @@ -79,7 +83,7 @@ <h1>Module <code>controlspec</code></h1>
</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 2018-04-23 17:20:49 </i>
<i style="float:right;">Last updated 2018-07-07 03:32:57 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
12 changes: 8 additions & 4 deletions doc/modules/encoders.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,27 +35,31 @@ <h1>norns</h1>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/audio.html">audio</a></li>
<li><a href="../modules/paramset.html">paramset</a></li>
<li><a href="../modules/controlspec.html">controlspec</a></li>
<li><strong>encoders</strong></li>
<li><a href="../modules/engine.html">engine</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/grid.html">grid</a></li>
<li><a href="../modules/hid.html">hid</a></li>
<li><a href="../modules/log.html">log</a></li>
<li><a href="../modules/menu.html">menu</a></li>
<li><a href="../modules/metro.html">metro</a></li>
<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/paramset.html">paramset</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/option.html">option</a></li>
<li><a href="../modules/osc.html">osc</a></li>
<li><a href="../modules/separator.html">separator</a></li>
<li><a href="../modules/taper.html">taper</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>
<li><a href="../modules/script.html">script</a></li>
<li><a href="../modules/state.html">state</a></li>
<li><a href="../modules/tabutil.html">tabutil</a></li>
<li><a href="../modules/textentry.html">textentry</a></li>
<li><a href="../modules/update.html">update</a></li>
<li><a href="../modules/util.html">util</a></li>
</ul>

Expand All @@ -79,7 +83,7 @@ <h1>Module <code>encoders</code></h1>
</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 2018-04-23 17:20:49 </i>
<i style="float:right;">Last updated 2018-07-07 03:32:57 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
12 changes: 8 additions & 4 deletions doc/modules/engine.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,27 +39,31 @@ <h2>Contents</h2>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/audio.html">audio</a></li>
<li><a href="../modules/paramset.html">paramset</a></li>
<li><a href="../modules/controlspec.html">controlspec</a></li>
<li><a href="../modules/encoders.html">encoders</a></li>
<li><strong>engine</strong></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/grid.html">grid</a></li>
<li><a href="../modules/hid.html">hid</a></li>
<li><a href="../modules/log.html">log</a></li>
<li><a href="../modules/menu.html">menu</a></li>
<li><a href="../modules/metro.html">metro</a></li>
<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/paramset.html">paramset</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/option.html">option</a></li>
<li><a href="../modules/osc.html">osc</a></li>
<li><a href="../modules/separator.html">separator</a></li>
<li><a href="../modules/taper.html">taper</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>
<li><a href="../modules/script.html">script</a></li>
<li><a href="../modules/state.html">state</a></li>
<li><a href="../modules/tabutil.html">tabutil</a></li>
<li><a href="../modules/textentry.html">textentry</a></li>
<li><a href="../modules/update.html">update</a></li>
<li><a href="../modules/util.html">util</a></li>
</ul>

Expand Down Expand Up @@ -238,7 +242,7 @@ <h3>Parameters:</h3>
</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 2018-04-23 17:20:49 </i>
<i style="float:right;">Last updated 2018-07-07 03:32:57 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
12 changes: 8 additions & 4 deletions doc/modules/grid.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,27 +39,31 @@ <h2>Contents</h2>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/audio.html">audio</a></li>
<li><a href="../modules/paramset.html">paramset</a></li>
<li><a href="../modules/controlspec.html">controlspec</a></li>
<li><a href="../modules/encoders.html">encoders</a></li>
<li><a href="../modules/engine.html">engine</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><strong>grid</strong></li>
<li><a href="../modules/hid.html">hid</a></li>
<li><a href="../modules/log.html">log</a></li>
<li><a href="../modules/menu.html">menu</a></li>
<li><a href="../modules/metro.html">metro</a></li>
<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/paramset.html">paramset</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/option.html">option</a></li>
<li><a href="../modules/osc.html">osc</a></li>
<li><a href="../modules/separator.html">separator</a></li>
<li><a href="../modules/taper.html">taper</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>
<li><a href="../modules/script.html">script</a></li>
<li><a href="../modules/state.html">state</a></li>
<li><a href="../modules/tabutil.html">tabutil</a></li>
<li><a href="../modules/textentry.html">textentry</a></li>
<li><a href="../modules/update.html">update</a></li>
<li><a href="../modules/util.html">util</a></li>
</ul>

Expand Down Expand Up @@ -324,7 +328,7 @@ <h3>Parameters:</h3>
</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 2018-04-23 17:20:49 </i>
<i style="float:right;">Last updated 2018-07-07 03:32:57 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
12 changes: 8 additions & 4 deletions doc/modules/hid.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,27 +39,31 @@ <h2>Contents</h2>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/audio.html">audio</a></li>
<li><a href="../modules/paramset.html">paramset</a></li>
<li><a href="../modules/controlspec.html">controlspec</a></li>
<li><a href="../modules/encoders.html">encoders</a></li>
<li><a href="../modules/engine.html">engine</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/grid.html">grid</a></li>
<li><strong>hid</strong></li>
<li><a href="../modules/log.html">log</a></li>
<li><a href="../modules/menu.html">menu</a></li>
<li><a href="../modules/metro.html">metro</a></li>
<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/paramset.html">paramset</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/number.html">number</a></li>
<li><a href="../modules/option.html">option</a></li>
<li><a href="../modules/osc.html">osc</a></li>
<li><a href="../modules/separator.html">separator</a></li>
<li><a href="../modules/taper.html">taper</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>
<li><a href="../modules/script.html">script</a></li>
<li><a href="../modules/state.html">state</a></li>
<li><a href="../modules/tabutil.html">tabutil</a></li>
<li><a href="../modules/textentry.html">textentry</a></li>
<li><a href="../modules/update.html">update</a></li>
<li><a href="../modules/util.html">util</a></li>
</ul>

Expand Down Expand Up @@ -341,7 +345,7 @@ <h3>Parameters:</h3>
</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 2018-04-23 17:20:49 </i>
<i style="float:right;">Last updated 2018-07-07 03:32:57 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
Loading

0 comments on commit 20d3eaf

Please sign in to comment.