5

我正在使用 doxygen 记录一个 C 项目，并将文件集合分组到模块中（其中每个模块都包含 ac 样式类的所有文档）。我所拥有的一切工作正常，除了所有模块名称都以大写字母开头，即使我使用全小写名称创建模块组也是如此。

例如，以下 doxygen 注释将在我的文档中生成一个模块“Foobar”，即使我添加到组“foobar”并希望该模块被称为“foobar”：

    /**
     *@addtogroup foobar
     *@{
     * (some documentation elements...)
     *@}
     */

虽然大写不会以任何严重的方式影响文档，但我想修复它以保持一致性（并且因为我不能让自己放手）。谷歌已经干了，有什么建议吗？

4

2 回答 2

3

我在doxygen 手册中几乎错过了这一点：

要定义一个组，您应该将 \defgroup 命令放在一个特殊的注释块中。该命令的第一个参数是应该唯一标识组的标签。第二个参数是应该出现在文档中的组的名称或标题。

所以你应该能够做到

@addtogroup foobar foobar
于 2013-08-13T22:13:50.183 回答
1

@E-rich的回答提供了一个可行的解决方案。

但是，如果您使用

\addtogroup foobar

在很多地方/文件中，必须使用将是一个令人头疼的维护

\addtogroup foobar foobar

在所有这些地方。最好使用：

\defgroup foobar foobar

然后离开使用

\addtogroup foobar

照原样。

使用我的建议，如果您愿意，可以很容易地将名称更改为更具描述性的名称。

\defgroup foobar The Foo and Bar Module
于 2017-02-03T19:56:29.520 回答