doxygen - 创建新的自定义命令，该命令将添加到Doxygen的一部分中

Question

我想在Doxygen中创建一个类似于\fn，\param或\var的自定义命令。

例如，我希望能够创建一个\option命令，该命令将如下使用:

/**
  \option option_1 This is the first option.
  \option option_2 This is the second option.
*/

输出如下:

选项:
option_1这是第一个选项。
option_2这是第二个选项。



简单的替换别名不起作用。例如，使用该别名:

ALIASES = option="\par Options:\n" 

我得到以下输出:

选项:
option_1这是第一个选项。

选项:
option_2这是第二个选项。

这不是我想要的。

赏金:

如果需要进一步说明，请参阅我的问题: Doxygen - Create custom command

Answer 1

虽然它不如@param干净，但是您可以使用以下别名模拟类似的行为:

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>"

别名可按以下方式使用以生成您要查找的输出:

/**
 * @options
 * @option{ option_1, This is the first option. }
 * @option{ option_2, This is the second option. }
 * @endoptions
 */

注意:这是以HTML为中心的，可能不会为其他格式产生合理的输出。