fix(doc): prevent doxygen confusion

This commit is contained in:
Lewis Russell 2024-02-06 15:08:17 +00:00 committed by Lewis Russell
parent 0db6946b39
commit c4417ae70c
2 changed files with 14 additions and 2 deletions

View File

@ -742,14 +742,14 @@ open_float({opts}, {...}) *vim.diagnostic.open_float()*
(`integer?, integer?`) ({float_bufnr}, {win_id}) (`integer?, integer?`) ({float_bufnr}, {win_id})
reset({namespace}, {bufnr}) *vim.diagnostic.reset()* reset({namespace}, {bufnr}) *vim.diagnostic.reset()*
Remove all diagnostics from the given namespace.
Unlike |vim.diagnostic.hide()|, this function removes all saved Unlike |vim.diagnostic.hide()|, this function removes all saved
diagnostics. They cannot be redisplayed using |vim.diagnostic.show()|. To diagnostics. They cannot be redisplayed using |vim.diagnostic.show()|. To
simply remove diagnostic decorations in a way that they can be simply remove diagnostic decorations in a way that they can be
re-displayed, use |vim.diagnostic.hide()|. re-displayed, use |vim.diagnostic.hide()|.
Parameters: ~ Parameters: ~
• {d} (`vim.Diagnostic`) Remove all diagnostics from the given
namespace.
• {namespace} (`integer?`) Diagnostic namespace. When omitted, remove • {namespace} (`integer?`) Diagnostic namespace. When omitted, remove
diagnostics from all namespaces. diagnostics from all namespaces.
• {bufnr} (`integer?`) Remove diagnostics for the given buffer. • {bufnr} (`integer?`) Remove diagnostics for the given buffer.

View File

@ -447,6 +447,8 @@ end
function Lua2DoxFilter:filter(filename) function Lua2DoxFilter:filter(filename)
local in_stream = StreamRead.new(filename) local in_stream = StreamRead.new(filename)
local last_was_magic = false
while not in_stream:eof() do while not in_stream:eof() do
local line = in_stream:getLine() local line = in_stream:getLine()
@ -457,6 +459,16 @@ function Lua2DoxFilter:filter(filename)
end end
if out_line then 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) writeln(out_line)
end end
end end