创建将添加到 Doxygen 中的部分的新自定义命令答案

【问题标题】：Create new custom command that will add to a section in Doxygen创建将添加到 Doxygen 中的部分的新自定义命令
【发布时间】：2011-07-10 18:56:44
【问题描述】：

我想在 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

【问题讨论】：

标签： doxygen

【解决方案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 为中心的，可能不会为其他格式产生合理的输出。

【讨论】：

【解决方案2】：

看起来 xrefitem 可能会按照您在上一个问题中的回答做您想做的事情： Custom tags with Doxygen

【讨论】：

该命令的作用是为给定命令创建一个单独的页面并创建指向该页面的链接。方法文档的输出与我的简单别名中的输出大致相同。绝对不是我想要的。