From ee89e7c6866d0d47a36b9fbb3e513cf6294468b8 Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Sun, 24 Nov 2019 03:57:46 -0500 Subject: [PATCH] doc: Add a new custom tag for signals emitted by a method. --- docs/config.ld | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/config.ld b/docs/config.ld index 182a4c281..82a6a388d 100644 --- a/docs/config.ld +++ b/docs/config.ld @@ -168,9 +168,9 @@ local function default_format_callback(self, params, _, md) end if params.type then - ret = ret .. '( '.. - params.type.value.. - " )" + ret = ret .. '('.. + md("`"..params.type.value.."`").. + ")" end return ret.." "..md(params.description) @@ -232,6 +232,19 @@ add_custom_tag = function(args) 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 kind_names={topic='Documentation', module='Libraries', script='Sample files'}