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.
This commit is contained in:
jacqueline
2024-03-07 17:22:06 +11:00
parent beb1f65495
commit 36a19182be
24 changed files with 678 additions and 230 deletions
+5 -2
View File
@@ -1,8 +1,11 @@
--- @meta
--- Module for interacting with playback volume. The Bluetooth and wired outputs store their current volume separately; this API only allows interacting with the volume of the currently used output device.
--- @class volume
--- @field current_pct Property
--- @field current_db Property
--- @field current_pct Property The current volume as a percentage of the current volume limit.
--- @field current_db Property The current volume in terms of decibels relative to line level (only applicable to headphone output)
--- @field left_bias Property An additional modifier in decibels to apply to the left channel (only applicable to headphone output)
--- @field limit_db Property The maximum allowed output volume, in terms of decibels relative to line level (only applicable to headphone output)
local volume = {}
return volume