From b09b9298a6caaa4f43e32dd7e19d2975cce95ab9 Mon Sep 17 00:00:00 2001 From: brian crabtree Date: Fri, 17 Mar 2023 18:55:00 -0400 Subject: [PATCH] regenerate docs --- doc/index.html | 2 +- doc/modules/Lattice.html | 2 +- doc/modules/arc.html | 2 +- doc/modules/audio.html | 2 +- doc/modules/clock.html | 2 +- doc/modules/controlspec.html | 2 +- doc/modules/core.crow.public.html | 2 +- doc/modules/core.crow.quote.html | 2 +- doc/modules/crow.html | 2 +- doc/modules/encoders.html | 2 +- doc/modules/engine.html | 2 +- doc/modules/gamepad.html | 2 +- doc/modules/grid.html | 56 ++++++++++++++++++++- doc/modules/hid.html | 2 +- doc/modules/keyboard.html | 2 +- doc/modules/lib.BeatClock.html | 2 +- doc/modules/lib.EnvGraph.html | 2 +- doc/modules/lib.FilterGraph.html | 2 +- doc/modules/lib.Graph.html | 2 +- doc/modules/lib.MusicUtil.html | 2 +- doc/modules/lib.UI.html | 2 +- doc/modules/lib.container.defaulttable.html | 2 +- doc/modules/lib.container.deque.html | 2 +- doc/modules/lib.container.observable.html | 2 +- doc/modules/lib.container.watchtable.html | 2 +- doc/modules/lib.container.weaktable.html | 2 +- doc/modules/lib.elca.html | 2 +- doc/modules/lib.er.html | 2 +- doc/modules/lib.fileselect.html | 2 +- doc/modules/lib.filters.html | 2 +- doc/modules/lib.formatters.html | 2 +- doc/modules/lib.intonation.html | 2 +- doc/modules/lib.lfo.html | 2 +- doc/modules/lib.listselect.html | 2 +- doc/modules/lib.pattern.html | 2 +- doc/modules/lib.sequins.html | 2 +- doc/modules/lib.tabutil.html | 2 +- doc/modules/lib.test.luaunit.html | 2 +- doc/modules/lib.textentry.html | 2 +- doc/modules/lib.textentry_kbd.html | 2 +- doc/modules/lib.timeline.html | 2 +- doc/modules/lib.util.html | 2 +- doc/modules/lib.voice.html | 2 +- doc/modules/metro.html | 2 +- doc/modules/midi.html | 2 +- doc/modules/norns.html | 2 +- doc/modules/osc.html | 2 +- doc/modules/params.control.html | 2 +- doc/modules/paramset.html | 2 +- doc/modules/poll.html | 2 +- doc/modules/screen.html | 2 +- doc/modules/script.html | 2 +- doc/modules/softcut.html | 2 +- lua/core/grid.lua | 4 +- 54 files changed, 109 insertions(+), 55 deletions(-) diff --git a/doc/index.html b/doc/index.html index 6ae814756..66922d0d0 100644 --- a/doc/index.html +++ b/doc/index.html @@ -318,7 +318,7 @@

Modules

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/Lattice.html b/doc/modules/Lattice.html index 5e88cdc83..d132d75de 100644 --- a/doc/modules/Lattice.html +++ b/doc/modules/Lattice.html @@ -617,7 +617,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/arc.html b/doc/modules/arc.html index 80930bad5..93bbd11e1 100644 --- a/doc/modules/arc.html +++ b/doc/modules/arc.html @@ -364,7 +364,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/audio.html b/doc/modules/audio.html index 9a12422c3..57cfa0aff 100644 --- a/doc/modules/audio.html +++ b/doc/modules/audio.html @@ -980,7 +980,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/clock.html b/doc/modules/clock.html index 0c80a904d..171281fe8 100644 --- a/doc/modules/clock.html +++ b/doc/modules/clock.html @@ -396,7 +396,7 @@

Fields

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/controlspec.html b/doc/modules/controlspec.html index 4503ae28c..34985d9a5 100644 --- a/doc/modules/controlspec.html +++ b/doc/modules/controlspec.html @@ -640,7 +640,7 @@

Presets

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/core.crow.public.html b/doc/modules/core.crow.public.html index 3d2ca070d..ff4248a53 100644 --- a/doc/modules/core.crow.public.html +++ b/doc/modules/core.crow.public.html @@ -251,7 +251,7 @@

Fields:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/core.crow.quote.html b/doc/modules/core.crow.quote.html index a88be236f..2b0900355 100644 --- a/doc/modules/core.crow.quote.html +++ b/doc/modules/core.crow.quote.html @@ -110,7 +110,7 @@

Module core.crow.quote

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/crow.html b/doc/modules/crow.html index ad9b9d27e..b168e1f87 100644 --- a/doc/modules/crow.html +++ b/doc/modules/crow.html @@ -209,7 +209,7 @@

Fields:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/encoders.html b/doc/modules/encoders.html index b631cfd39..061533523 100644 --- a/doc/modules/encoders.html +++ b/doc/modules/encoders.html @@ -200,7 +200,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/engine.html b/doc/modules/engine.html index f5e49ddff..4d345490f 100644 --- a/doc/modules/engine.html +++ b/doc/modules/engine.html @@ -285,7 +285,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/gamepad.html b/doc/modules/gamepad.html index 00071a479..dcddffd80 100644 --- a/doc/modules/gamepad.html +++ b/doc/modules/gamepad.html @@ -308,7 +308,7 @@

Tables

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/grid.html b/doc/modules/grid.html index 52c7978d8..356205141 100644 --- a/doc/modules/grid.html +++ b/doc/modules/grid.html @@ -112,6 +112,14 @@

Functions

Grid.remove (dev) static callback when any grid device is removed; user scripts can redefine + + + Grid:rotation (val) + set grid rotation. + + + Grid:tilt_enable (id, val) + enable/disable grid tilt. Grid:led (x, y, val) @@ -187,6 +195,52 @@

Parameters:

+ +
+ + Grid:rotation (val) +
+
+ set grid rotation. + + +

Parameters:

+ + + + + + +
+
+ + Grid:tilt_enable (id, val) +
+
+ enable/disable grid tilt. + + +

Parameters:

+ + + + + +
@@ -314,7 +368,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/hid.html b/doc/modules/hid.html index d0812044b..789eed7d2 100644 --- a/doc/modules/hid.html +++ b/doc/modules/hid.html @@ -195,7 +195,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/keyboard.html b/doc/modules/keyboard.html index 5f03eec50..49f2b8db4 100644 --- a/doc/modules/keyboard.html +++ b/doc/modules/keyboard.html @@ -268,7 +268,7 @@

Tables

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.BeatClock.html b/doc/modules/lib.BeatClock.html index 3af1bfe12..04fa62cee 100644 --- a/doc/modules/lib.BeatClock.html +++ b/doc/modules/lib.BeatClock.html @@ -372,7 +372,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.EnvGraph.html b/doc/modules/lib.EnvGraph.html index 938804223..6f4df9d66 100644 --- a/doc/modules/lib.EnvGraph.html +++ b/doc/modules/lib.EnvGraph.html @@ -726,7 +726,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.FilterGraph.html b/doc/modules/lib.FilterGraph.html index 3865ce874..83e9c0e5f 100644 --- a/doc/modules/lib.FilterGraph.html +++ b/doc/modules/lib.FilterGraph.html @@ -320,7 +320,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.Graph.html b/doc/modules/lib.Graph.html index a5df51d9c..e715abe04 100644 --- a/doc/modules/lib.Graph.html +++ b/doc/modules/lib.Graph.html @@ -1345,7 +1345,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.MusicUtil.html b/doc/modules/lib.MusicUtil.html index 1843c4e3d..b6f3f9921 100644 --- a/doc/modules/lib.MusicUtil.html +++ b/doc/modules/lib.MusicUtil.html @@ -761,7 +761,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.UI.html b/doc/modules/lib.UI.html index 1ad33f939..850f8fc42 100644 --- a/doc/modules/lib.UI.html +++ b/doc/modules/lib.UI.html @@ -1247,7 +1247,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.container.defaulttable.html b/doc/modules/lib.container.defaulttable.html index 37fdfb989..c1d7f56b7 100644 --- a/doc/modules/lib.container.defaulttable.html +++ b/doc/modules/lib.container.defaulttable.html @@ -116,7 +116,7 @@

Module lib.container.defaulttable

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.container.deque.html b/doc/modules/lib.container.deque.html index ce44ba21f..402a6d69f 100644 --- a/doc/modules/lib.container.deque.html +++ b/doc/modules/lib.container.deque.html @@ -444,7 +444,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.container.observable.html b/doc/modules/lib.container.observable.html index 18525df1c..1d07bf1b9 100644 --- a/doc/modules/lib.container.observable.html +++ b/doc/modules/lib.container.observable.html @@ -285,7 +285,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.container.watchtable.html b/doc/modules/lib.container.watchtable.html index 027574fbf..b43f1326f 100644 --- a/doc/modules/lib.container.watchtable.html +++ b/doc/modules/lib.container.watchtable.html @@ -111,7 +111,7 @@

Module lib.container.watchtable

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.container.weaktable.html b/doc/modules/lib.container.weaktable.html index bfe8f2bba..604e59d39 100644 --- a/doc/modules/lib.container.weaktable.html +++ b/doc/modules/lib.container.weaktable.html @@ -110,7 +110,7 @@

Module lib.container.weaktable

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.elca.html b/doc/modules/lib.elca.html index d12bf2d57..56b80819b 100644 --- a/doc/modules/lib.elca.html +++ b/doc/modules/lib.elca.html @@ -308,7 +308,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.er.html b/doc/modules/lib.er.html index 01b0cee51..d75c993db 100644 --- a/doc/modules/lib.er.html +++ b/doc/modules/lib.er.html @@ -158,7 +158,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.fileselect.html b/doc/modules/lib.fileselect.html index 575962664..91555586f 100644 --- a/doc/modules/lib.fileselect.html +++ b/doc/modules/lib.fileselect.html @@ -108,7 +108,7 @@

Module lib.fileselect

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.filters.html b/doc/modules/lib.filters.html index 7770e49f7..d772a40f1 100644 --- a/doc/modules/lib.filters.html +++ b/doc/modules/lib.filters.html @@ -315,7 +315,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.formatters.html b/doc/modules/lib.formatters.html index 95b241676..9a509f6ec 100644 --- a/doc/modules/lib.formatters.html +++ b/doc/modules/lib.formatters.html @@ -455,7 +455,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.intonation.html b/doc/modules/lib.intonation.html index 0f9b1a254..c5d4722bd 100644 --- a/doc/modules/lib.intonation.html +++ b/doc/modules/lib.intonation.html @@ -329,7 +329,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.lfo.html b/doc/modules/lib.lfo.html index 7c9550502..98a1f135f 100644 --- a/doc/modules/lib.lfo.html +++ b/doc/modules/lib.lfo.html @@ -313,7 +313,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.listselect.html b/doc/modules/lib.listselect.html index 6672688f5..42504f10c 100644 --- a/doc/modules/lib.listselect.html +++ b/doc/modules/lib.listselect.html @@ -108,7 +108,7 @@

Module lib.listselect

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.pattern.html b/doc/modules/lib.pattern.html index 7000c7869..4fc4432f2 100644 --- a/doc/modules/lib.pattern.html +++ b/doc/modules/lib.pattern.html @@ -366,7 +366,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.sequins.html b/doc/modules/lib.sequins.html index 2aa3b7c4c..79a7d8aa1 100644 --- a/doc/modules/lib.sequins.html +++ b/doc/modules/lib.sequins.html @@ -146,7 +146,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.tabutil.html b/doc/modules/lib.tabutil.html index 2ca36ff5b..bf3dae26b 100644 --- a/doc/modules/lib.tabutil.html +++ b/doc/modules/lib.tabutil.html @@ -571,7 +571,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.test.luaunit.html b/doc/modules/lib.test.luaunit.html index 8bc39a67d..5bb5bc522 100644 --- a/doc/modules/lib.test.luaunit.html +++ b/doc/modules/lib.test.luaunit.html @@ -277,7 +277,7 @@

Fields:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.textentry.html b/doc/modules/lib.textentry.html index 0906a9c6f..9efd3c2e5 100644 --- a/doc/modules/lib.textentry.html +++ b/doc/modules/lib.textentry.html @@ -108,7 +108,7 @@

Module lib.textentry

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.textentry_kbd.html b/doc/modules/lib.textentry_kbd.html index 7352600e6..edec9c487 100644 --- a/doc/modules/lib.textentry_kbd.html +++ b/doc/modules/lib.textentry_kbd.html @@ -109,7 +109,7 @@

Module lib.textentry_kbd

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.timeline.html b/doc/modules/lib.timeline.html index 929095571..b71039179 100644 --- a/doc/modules/lib.timeline.html +++ b/doc/modules/lib.timeline.html @@ -263,7 +263,7 @@

Fields:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.util.html b/doc/modules/lib.util.html index 1f4c4c406..38507cd82 100644 --- a/doc/modules/lib.util.html +++ b/doc/modules/lib.util.html @@ -850,7 +850,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/lib.voice.html b/doc/modules/lib.voice.html index 0335f5bde..a6489a905 100644 --- a/doc/modules/lib.voice.html +++ b/doc/modules/lib.voice.html @@ -247,7 +247,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/metro.html b/doc/modules/metro.html index 25e8ed652..1c0f8e882 100644 --- a/doc/modules/metro.html +++ b/doc/modules/metro.html @@ -281,7 +281,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/midi.html b/doc/modules/midi.html index 25f9a00af..16f60c12a 100644 --- a/doc/modules/midi.html +++ b/doc/modules/midi.html @@ -676,7 +676,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/norns.html b/doc/modules/norns.html index fcaa00957..ba758989c 100644 --- a/doc/modules/norns.html +++ b/doc/modules/norns.html @@ -323,7 +323,7 @@

Fields

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/osc.html b/doc/modules/osc.html index f767305ca..621c2ac3b 100644 --- a/doc/modules/osc.html +++ b/doc/modules/osc.html @@ -204,7 +204,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/params.control.html b/doc/modules/params.control.html index 82888ef70..a5c35ca84 100644 --- a/doc/modules/params.control.html +++ b/doc/modules/params.control.html @@ -426,7 +426,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/paramset.html b/doc/modules/paramset.html index 47f85114d..df9ff08e1 100644 --- a/doc/modules/paramset.html +++ b/doc/modules/paramset.html @@ -1112,7 +1112,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/poll.html b/doc/modules/poll.html index 2fca0b0c8..5bca4c18b 100644 --- a/doc/modules/poll.html +++ b/doc/modules/poll.html @@ -233,7 +233,7 @@

Parameters:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/screen.html b/doc/modules/screen.html index 34f25fe22..78c214027 100644 --- a/doc/modules/screen.html +++ b/doc/modules/screen.html @@ -1437,7 +1437,7 @@

Usage:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/script.html b/doc/modules/script.html index 040ce33a1..cd4e80f7d 100644 --- a/doc/modules/script.html +++ b/doc/modules/script.html @@ -212,7 +212,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/doc/modules/softcut.html b/doc/modules/softcut.html index 870467ec4..92a02b6de 100644 --- a/doc/modules/softcut.html +++ b/doc/modules/softcut.html @@ -2058,7 +2058,7 @@

Returns:

generated by LDoc 1.4.6 -Last updated 2023-03-17 18:42:40 +Last updated 2023-03-17 18:54:24
diff --git a/lua/core/grid.lua b/lua/core/grid.lua index 0af0ab7ec..a9aed0cc4 100755 --- a/lua/core/grid.lua +++ b/lua/core/grid.lua @@ -79,14 +79,14 @@ end -- @param dev : a Grid table function Grid.remove(dev) end --- set grid rotation. +--- set grid rotation. -- @tparam integer val : rotation 0,90,180,270 as [0, 3] function Grid:rotation(val) _norns.grid_set_rotation(self.dev, val) end --- enable/disable grid tilt. +--- enable/disable grid tilt. -- @tparam integer id : sensor -- @tparam integer val : off/on [0, 1] function Grid:tilt_enable(id, val)