aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/_meta/api_keysets_extra.lua
diff options
context:
space:
mode:
authorLewis Russell <lewis6991@gmail.com>2025-06-16 11:45:44 +0100
committerLewis Russell <me@lewisr.dev>2025-06-26 13:54:04 +0100
commit76de3e2d07f20c77b7ee6f72c8ec27b045e51ed1 (patch)
tree459bd875becca91797f796b1e06f73eb7d40c458 /runtime/lua/vim/_meta/api_keysets_extra.lua
parent3eaa6c5a665999a9e374338137841937541ec33e (diff)
downloadrneovim-76de3e2d07f20c77b7ee6f72c8ec27b045e51ed1.tar.gz
rneovim-76de3e2d07f20c77b7ee6f72c8ec27b045e51ed1.tar.bz2
rneovim-76de3e2d07f20c77b7ee6f72c8ec27b045e51ed1.zip
docs(api): document types using LuaCATS types
- Render Lua types in api.txt. - Added `DictAs(name)` API type which acts the same as `Dict` (no parens) when generating the dispatchers, but acts the same as `Dict(name)` when generating docs. - Added `Tuple(...)` API type which is the treated the as `Array` for generating the dispatchers, but is used to document richer types. - Added `Enum(...)` API type to better document enums - Improve typing of some API functions. - Improve c_grammar to properly parse API types and replace string pattern logic in the parsers. - Removed all the hardcoded type overrides in gen_eval_files.lua
Diffstat (limited to 'runtime/lua/vim/_meta/api_keysets_extra.lua')
-rw-r--r--runtime/lua/vim/_meta/api_keysets_extra.lua23
1 files changed, 4 insertions, 19 deletions
diff --git a/runtime/lua/vim/_meta/api_keysets_extra.lua b/runtime/lua/vim/_meta/api_keysets_extra.lua
index ed93345a2b..a3a444ae98 100644
--- a/runtime/lua/vim/_meta/api_keysets_extra.lua
+++ b/runtime/lua/vim/_meta/api_keysets_extra.lua
@@ -54,12 +54,6 @@ error('Cannot require a meta file')
--- @field [3] integer col
--- @field [4] vim.api.keyset.extmark_details?
---- @class vim.api.keyset.get_mark
---- @field [1] integer row
---- @field [2] integer col
---- @field [3] integer buffer
---- @field [4] string buffername
-
--- @class vim.api.keyset.get_autocmds.ret
--- @field id? integer
--- @field group? integer
@@ -212,7 +206,7 @@ error('Cannot require a meta file')
--- @field default string|boolean|integer
--- @field allows_duplicates boolean
---- @class vim.api.keyset.parse_cmd.mods
+--- @class vim.api.keyset.cmd.mods
--- @field filter { force: boolean, pattern: string }
--- @field silent boolean
--- @field emsg_silent boolean
@@ -234,18 +228,9 @@ error('Cannot require a meta file')
--- @field horizontal boolean
--- @field split ''|'botright'|'topleft'|'belowright'|'aboveleft'
---- @class vim.api.keyset.parse_cmd
---- @field addr 'line'|'arg'|'buf'|'load'|'win'|'tab'|'qf'|'none'|'?'
---- @field args string[]
---- @field bang boolean
---- @field cmd string
---- @field magic {bar: boolean, file: boolean}
---- @field mods vim.api.keyset.parse_cmd.mods
---- @field nargs '0'|'1'|'?'|'+'|'*'
---- @field nextcmd string
---- @field range? integer[]
---- @field count? integer
---- @field reg? string
+--- @class vim.api.keyset.cmd.magic
+--- @field bar boolean
+--- @field file boolean
--- @class vim.api.keyset.eval_statusline_ret.highlight
--- @field start integer