aboutsummaryrefslogtreecommitdiff
path: root/src/gen/gen_api_dispatch.lua
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2025-03-18 06:18:37 -0700
committerGitHub <noreply@github.com>2025-03-18 06:18:37 -0700
commit7333c39e6cc78786289d88c65fbe10e4ce78992b (patch)
treeaf0deb9a02b82c19e6bf89e2b5bc8fb9123dd5d5 /src/gen/gen_api_dispatch.lua
parent29a47b39ccd0317e815632439966f0f1343d96cf (diff)
downloadrneovim-7333c39e6cc78786289d88c65fbe10e4ce78992b.tar.gz
rneovim-7333c39e6cc78786289d88c65fbe10e4ce78992b.tar.bz2
rneovim-7333c39e6cc78786289d88c65fbe10e4ce78992b.zip
docs: misc #32959
Diffstat (limited to 'src/gen/gen_api_dispatch.lua')
-rw-r--r--src/gen/gen_api_dispatch.lua8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/gen/gen_api_dispatch.lua b/src/gen/gen_api_dispatch.lua
index a5d0890c2f..b5433527bc 100644
--- a/src/gen/gen_api_dispatch.lua
+++ b/src/gen/gen_api_dispatch.lua
@@ -1,3 +1,5 @@
+-- Generates C code to bridge API <=> Lua.
+--
-- Example (manual) invocation:
--
-- make
@@ -192,7 +194,7 @@ for _, f in ipairs(shallowcopy(functions)) do
.. ' has deprecated alias\n'
.. newname
.. ' which has a separate implementation.\n'
- .. 'Please remove it from src/nvim/api/dispatch_deprecated.lua'
+ .. 'Remove it from src/nvim/api/dispatch_deprecated.lua'
)
os.exit(1)
end
@@ -729,6 +731,10 @@ output:write('\n')
local lua_c_functions = {}
+--- Generates C code to bridge RPC API <=> Lua.
+---
+--- Inspect the result here:
+--- build/src/nvim/auto/api/private/dispatch_wrappers.generated.h
local function process_function(fn)
local lua_c_function_name = ('nlua_api_%s'):format(fn.name)
write_shifted_output(