我正在使用doxygen记录一个C项目,并将文件集合分组到模块中(其中每个模块包含c样式类的所有文档)。我所做的一切都很好,除了所有模块名称都以大写字母开头,即使我创建了一个全小写名称的模块组。
例如,以下doxygen注释将在我的文档中生成一个模块“Foobar”,即使我添加到组“foobar”并希望该模块被称为“foobar”:
/**
*@addtogroup foobar
*@{
* (some documentation elements...)
*@}
*/
虽然大写不会以任何严肃的方式影响文档,但我想修复它以保持一致性(因为我不能让自己放手)。谷歌已经干了,有什么建议吗?
答案 0 :(得分:2)
我几乎错过了doxygen manual:
要定义组,您应该将\ defgroup命令放在特殊的注释块中。该命令的第一个参数是一个唯一标识该组的标签。第二个参数是组中的名称或标题,它应该出现在文档中。
所以你应该能够做到
@addtogroup foobar foobar
答案 1 :(得分:1)
answer by @E-rich提供了一个有效的解决方案。
但是,如果你使用
\addtogroup foobar
在许多地方/文件中,必须使用
是一个令人头疼的问题\addtogroup foobar foobar
在所有这些地方。最好使用:
\defgroup foobar foobar
然后继续使用
\addtogroup foobar
原样。
根据我的建议,如果您愿意,可以很容易地将名称更改为更具描述性的名称。
\defgroup foobar The Foo and Bar Module