4

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

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

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

我尝试使用这样的别名:

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

它可以工作,但我担心它与样式表无关:如果明天我想更改 css,那么这个自定义命令将生成看起来与 seealso、作者和所有其他部分不同的输出。

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

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

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

4

1 回答 1

4

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

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

然后在记录的代码中:

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

(来自我对该问题的回答:Custom tags with Doxygen

于 2009-10-30T15:10:22.533 回答