在doxygen中添加自定义命令

Question

我希望在我的doxygen文档中添加自定义命令。基本上，对于我为之编写文档的每个C函数，我需要写出哪些全局变量以读模式或写模式“触摸”。这就像“参见”列表，只是标题不同。

在我的文件中，我想写这样的东西：

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

我尝试使用如下别名：

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

它能工作，但我担心它与样式表无关：如果明天我想要更改css，那么这个自定义命令将生成与seealso、author和所有其他部分不同的输出。

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

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

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

- Emiliano

Answer 1

如果您想隐藏第二个参数，可以结合使用 \xrefitem 和 ALIASES。以下是我在需求中使用的示例：

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

接下来在文档化的代码中：

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

（来自我对该问题的回答：Doxygen中的自定义标签）

- mouviciel