neovim

commit c4417ae70c03815c2fb64edb479017e79d223cf7
parent 0db6946b39fd031c9fe3c38a7dd54efa9131a6ac
Author: Lewis Russell <lewis6991@gmail.com>
Date:   Tue,  6 Feb 2024 15:08:17 +0000

fix(doc): prevent doxygen confusion

Diffstat:
M
runtime/doc/diagnostic.txt
 | 
4
++--
M
scripts/lua2dox.lua
 | 
12
++++++++++++

2 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/runtime/doc/diagnostic.txt b/runtime/doc/diagnostic.txt
@@ -742,14 +742,14 @@ open_float({opts}, {...})                        *vim.diagnostic.open_float()*
         (`integer?, integer?`) ({float_bufnr}, {win_id})
 
 reset({namespace}, {bufnr})                           *vim.diagnostic.reset()*
+    Remove all diagnostics from the given namespace.
+
     Unlike |vim.diagnostic.hide()|, this function removes all saved
     diagnostics. They cannot be redisplayed using |vim.diagnostic.show()|. To
     simply remove diagnostic decorations in a way that they can be
     re-displayed, use |vim.diagnostic.hide()|.
 
     Parameters: ~
-      • {d}          (`vim.Diagnostic`) Remove all diagnostics from the given
-             namespace.
       • {namespace}  (`integer?`) Diagnostic namespace. When omitted, remove
                      diagnostics from all namespaces.
       • {bufnr}      (`integer?`) Remove diagnostics for the given buffer.
diff --git a/scripts/lua2dox.lua b/scripts/lua2dox.lua
@@ -447,6 +447,8 @@ end
 function Lua2DoxFilter:filter(filename)
   local in_stream = StreamRead.new(filename)
 
+  local last_was_magic = false
+
   while not in_stream:eof() do
     local line = in_stream:getLine()
 
@@ -457,6 +459,16 @@ function Lua2DoxFilter:filter(filename)
     end
 
     if out_line then
+      -- Ensure all magic blocks associate with some object to prevent doxygen
+      -- from getting confused.
+      if vim.startswith(out_line, '///') then
+        last_was_magic = true
+      else
+        if last_was_magic and out_line:match('^// zz: [^-]+') then
+          writeln('local_function _ignore() {}')
+        end
+        last_was_magic = false
+      end
       writeln(out_line)
     end
   end