diff options
| author | jacqueline <me@jacqueline.id.au> | 2024-03-07 17:22:06 +1100 |
|---|---|---|
| committer | jacqueline <me@jacqueline.id.au> | 2024-03-07 17:22:06 +1100 |
| commit | 36a19182bec171d6376e51f5689aaf70b9d6fbad (patch) | |
| tree | b75be5f1567510ce2c60693c978a6ddf0b879905 /luals-stubs/controls.lua | |
| parent | beb1f654958c28429323fcb9622c9c8d206979a3 (diff) | |
| download | tangara-fw-36a19182bec171d6376e51f5689aaf70b9d6fbad.tar.gz | |
Use luals-stubs as the source of truth for docs, instead of maintaining
separate docs stubs
Includes introducing a cool new script to turn lua-language-server's
json output into markdown documentation.
Diffstat (limited to 'luals-stubs/controls.lua')
| -rw-r--r-- | luals-stubs/controls.lua | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/luals-stubs/controls.lua b/luals-stubs/controls.lua new file mode 100644 index 00000000..7034dc55 --- /dev/null +++ b/luals-stubs/controls.lua @@ -0,0 +1,12 @@ +--- @meta + +--- The `controls` module contains Properties relating to the device's physical +--- controls. These controls include the touchwheel, the lock switch, and the +--- side buttons. +--- @class controls +--- @field scheme Property The currently configured control scheme +--- @field scroll_sensitivity Property How much rotational motion is required on the touchwheel per scroll tick. +--- @field lock_switch Property The current state of the device's lock switch. +local controls = {} + +return controls |
