创建将添加到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这是第二个选项.

这不是我要找的.

---

BOUNTY:

如果需要进一步说明,请参阅我的问题:Doxygen - 创建自定义命令

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