doc: Add a new custom tag for signals emitted by a method.
This commit is contained in:
parent
7831a3f58d
commit
ee89e7c686
|
@ -168,9 +168,9 @@ local function default_format_callback(self, params, _, md)
|
||||||
end
|
end
|
||||||
|
|
||||||
if params.type then
|
if params.type then
|
||||||
ret = ret .. '<span class="parameter">( '..
|
ret = ret .. '<span class="parameter">('..
|
||||||
params.type.value..
|
md("`"..params.type.value.."`")..
|
||||||
" )</span>"
|
")</span>"
|
||||||
end
|
end
|
||||||
|
|
||||||
return ret.." "..md(params.description)
|
return ret.." "..md(params.description)
|
||||||
|
@ -232,6 +232,19 @@ add_custom_tag = function(args)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
-- When a type will request a permission.
|
||||||
|
-- @emits class signal Message[...]
|
||||||
|
add_custom_tag {
|
||||||
|
name = "emits",
|
||||||
|
title = "Emit signals",
|
||||||
|
hidden = false,
|
||||||
|
params = {
|
||||||
|
{
|
||||||
|
name = "name"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
-- More fitting section names
|
-- More fitting section names
|
||||||
kind_names={topic='Documentation', module='Libraries', script='Sample files'}
|
kind_names={topic='Documentation', module='Libraries', script='Sample files'}
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue