mirror of
https://github.com/bkaradzic/bgfx.git
synced 2026-08-14 23:29:40 +00:00
IDL: Improve docs. (#3614)
This commit is contained in:
committed by
GitHub
parent
c10271dc28
commit
3e6455e6b0
@@ -708,7 +708,19 @@ function codegen.doxygen_type(doxygen, func, cname)
|
||||
end
|
||||
end
|
||||
result[#result+1] = "///"
|
||||
return table.concat(result, "\n")
|
||||
|
||||
-- Collapse consecutive empty comment lines (///) into at most one.
|
||||
local collapsed = {}
|
||||
for _, line in ipairs(result) do
|
||||
local is_empty = (line == "///" or line == "/// ")
|
||||
local prev_empty = #collapsed > 0 and (collapsed[#collapsed] == "///" or collapsed[#collapsed] == "/// ")
|
||||
if is_empty and prev_empty then
|
||||
-- skip duplicate empty comment line
|
||||
else
|
||||
collapsed[#collapsed+1] = line
|
||||
end
|
||||
end
|
||||
return table.concat(collapsed, "\n")
|
||||
end
|
||||
|
||||
function codegen.doxygen_ctype(doxygen, func)
|
||||
@@ -728,7 +740,19 @@ function codegen.doxygen_ctype(doxygen, func)
|
||||
end
|
||||
result[#result+1] = " *"
|
||||
result[#result+1] = " */"
|
||||
return table.concat(result, "\n")
|
||||
|
||||
-- Collapse consecutive empty comment lines ( *) into at most one.
|
||||
local collapsed = {}
|
||||
for _, line in ipairs(result) do
|
||||
local is_empty = (line == " *" or line == " * ")
|
||||
local prev_empty = #collapsed > 0 and (collapsed[#collapsed] == " *" or collapsed[#collapsed] == " * ")
|
||||
if is_empty and prev_empty then
|
||||
-- skip duplicate empty comment line
|
||||
else
|
||||
collapsed[#collapsed+1] = line
|
||||
end
|
||||
end
|
||||
return table.concat(collapsed, "\n")
|
||||
end
|
||||
|
||||
local enum_temp = [[
|
||||
|
||||
Reference in New Issue
Block a user