问题描述
我想在Doxygen中创建自定义命令，类似于 \fn \param 或 \var 。
I would like to create a custom command in Doxygen similar to \fn \param or \var.
例如，我希望能够创建 \选项命令，如下所示：
For example I would like to be able to create a \option command which I would use as follows:
/**
\option option_1 This is the first option.
\option option_2 This is the second option.
*/
输出如下：
选项：
option_1这是第一个选项。
option_2这是第二个选项。
Options:
option_1 This is the first option.
option_2 This is the second option.
简单的替换别名不起作用。例如，使用以下别名：
A simple substitution alias does not work. For example with this alias:
ALIASES = option="\par Options:\n"
我得到以下输出：
选项：
option_1这是第一个选项。
Options:
option_1 This is the first option.
选项：
option_2这是第二个选项。
Options:
option_2 This is the second option.
这不是我想要的。
赏金：
如果需要进一步说明，请参阅我的问题：
If any further clarification is needed, see my question: Doxygen - Create custom command
推荐答案
它不如@param干净，您可以使用以下别名模拟类似的行为：
While it is not as clean as @param, you can emulate similar behavior with the following aliases:
ALIASES += options="<dl class="params"><dt>Options</dt><dd><table class="params">"
ALIASES += option{2}="<tr><td class="paramname">\1</td><td>\2</td></tr>"
ALIASES += endoptions="</table></dd></dl>"
别名可以按如下方式使用以生成您要查找的输出：
The aliases can be used as follows to produce the output you're looking for:
/**
* @options
* @option{ option_1, This is the first option. }
* @option{ option_2, This is the second option. }
* @endoptions
*/
注意：这是以HTML为中心的并且可能不会为其他格式产生合理的输出。
Note: This is HTML-centric and likely will not produce reasonable output for other formats.
这篇关于创建新的自定义命令，该命令将添加到Doxygen的一部分中的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！