在doxygen中添加一个自定义命令
问题描述:
我想给我的doxygen文档添加一个自定义命令。基本上对于我正在编写doc的每个C函数,我需要编写哪些全局变量在读取模式或写入模式下“被触摸”。这就像“另请参阅”列表,只是不同的标题。在doxygen中添加一个自定义命令
在我的文件,我想写点东西像这样:
/*
* \read-globals #var1, #var2
*
* \write-globals #var3
*/
我有这样的一个别名尝试:
read-globals = \par <b>Globals read</b>\n
它的工作原理,但我担心,这是独立的样式表:如果明天我要更改css,那么这个自定义命令会生成与seealso,author和其他所有部分不同的输出。
基本上我只是想复制其他标准命令的格式。
另一个选择是使用\ xrefitem命令,它也起作用,但它需要引入一个段作为第二个参数,在我的情况下它是完全无用的(也许它可以以某种方式隐藏起来?)。
有没有一个“正确的方法”来实现我的目标?
答
如果要隐藏第二个参数,则可以合并\xrefitem
和ALIASES
。下面是我使用的要求为例:
ALIASES += "req=\xrefitem req \"Requirement\" \"Requirements\" "
然后在文档代码:
/// \req #42 The system shall work in any situation
(从我的回答这个问题:Custom tags with Doxygen)