From be74807eef13ff8c90d55cf8b22b01d6d33b1641 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 18 Jul 2023 15:42:30 +0100
Subject: docs(lua): more improvements (#24387)

* docs(lua): teach lua2dox how to table

* docs(lua): teach gen_vimdoc.py about local functions

No more need to mark local functions with @private

* docs(lua): mention @nodoc and @meta in dev-lua-doc

* fixup!

Co-authored-by: Justin M. Keyes <justinkz@gmail.com>

---------

Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
---
 scripts/lua2dox.lua | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

(limited to 'scripts/lua2dox.lua')

diff --git a/scripts/lua2dox.lua b/scripts/lua2dox.lua
index be72b9e1c0..9a666ea629 100644
--- a/scripts/lua2dox.lua
+++ b/scripts/lua2dox.lua
@@ -160,6 +160,7 @@ end
 local function process_magic(line, generics)
   line = line:gsub('^%s+@', '@')
   line = line:gsub('@package', '@private')
+  line = line:gsub('@nodoc', '@private')
 
   if not vim.startswith(line, '@') then -- it's a magic comment
     return '/// ' .. line
@@ -327,6 +328,11 @@ local function process_function_header(line)
       .. fn:sub(paren_start + 1)
   end
 
+  if line:match('local') then
+    -- Special: tell gen_vimdoc.py this is a local function.
+    return 'local_function ' .. fn .. '{}'
+  end
+
   -- add vanilla function
   return 'function ' .. fn .. '{}'
 end
@@ -336,6 +342,9 @@ end
 --- @param generics table<string,string>>
 --- @return string?
 local function process_line(line, in_stream, generics)
+  local line_raw = line
+  line = vim.trim(line)
+
   if vim.startswith(line, '---') then
     return process_magic(line:sub(4), generics)
   end
@@ -348,6 +357,14 @@ local function process_line(line, in_stream, generics)
     return process_function_header(line)
   end
 
+  if not line:match('^local') then
+    local v = line_raw:match('^([A-Za-z][.a-zA-Z_]*)%s+%=')
+    if v and v:match('%.') then
+      -- Special: this lets gen_vimdoc.py handle tables.
+      return 'table '..v..'() {}'
+    end
+  end
+
   if #line > 0 then -- we don't know what this line means, so just comment it out
     return '// zz: ' .. line
   end
@@ -363,11 +380,11 @@ function Lua2DoxFilter:filter(filename)
   local generics = {} --- @type table<string,string>
 
   while not in_stream:eof() do
-    local line = vim.trim(in_stream:getLine())
+    local line = in_stream:getLine()
 
     local out_line = process_line(line, in_stream, generics)
 
-    if not vim.startswith(line, '---') then
+    if not vim.startswith(vim.trim(line), '---') then
       generics = {}
     end
 
-- 
cgit