在doxygen中添加自定义命令

时间:2009-10-30 11:09:23

标签: documentation doxygen

我想在我的doxygen文档中添加自定义命令。基本上对于我正在编写doc的每个C函数,我需要在读模式或写模式下编写哪些全局变量被“触及”。它就像“另请参见”列表,只是有不同的标题。

在我的文件中,我想写这样的东西:

/*
 * \read-globals   #var1, #var2
 *
 * \write-globals  #var3
 */

我尝试使用这样的别名:

read-globals = \par <b>Globals read</b>\n

它有效,但我担心它的样式表是独立的:如果明天我要更改css,那么这个自定义命令将生成与seealso,author和所有其他部分不同的输出。

基本上我只想从其他标准命令中复制格式。

另一种选择是使用\ xrefitem命令,它也可以,但它需要引入一个部分作为第二个参数,在我的情况下完全没用(也许它可以以某种方式隐藏?)。

是否有“正确的方法”来实现我的目标?

1 个答案:

答案 0 :(得分:4)

如果要隐藏第二个参数,可以合并\xrefitemALIASES。以下是我用于需求的示例:

ALIASES += "req=\xrefitem req \"Requirement\" \"Requirements\" "

然后在文档化的代码中:

/// \req #42 The system shall work in any situation

(根据我对该问题的回答:Custom tags with Doxygen