4

我需要一些在 C 代码上使用 Doxygen 的基本帮助。所有基本文档都很好，我需要帮助构建长长的文件和函数列表。

我有一个 C 源代码树，如下所示：

src/
 +--util/
    +--file1.h
    +--file1.c
    +--file2.h
    +--file2.c
 +--stats/
    +--file3.h
 +--etc/

很标准。目前 doxygen 生成所有文件的平面文件列表。我们将 src/ 的每个 dub-dir 称为“模块”，因此记录这似乎非常适合 Doxygen 模块/组。

我应该如何使用分组命令来镜像上面的目录结构？我想在生成的文档中有一个模块 util 链接到 file1 和 file2 文档。就像 JavaDoc 对待一个包一样。

将 /addtogroup util & @{ 标记添加到每个头文件会生成一个迷你站点，其中包含所有头文件中所有数据结构等的扁平列表，这不是我所期望或想要的。也许这就是 doxygen 组应该做的事情，即当代码跨多个文件实现时统一记录 API？

4

1 回答 1

1

使用模块的一个更简单的选择是使用@page和@subpage。要获得与您描述的布局类似的内容，您可以使用以下内容：

@page util Util
This page describes util module.
@subpage file1
@subpage file2

@page stats Stats
This page describes stats module.
@subpage file3

@page etc
Blah blah blah

@page file1 File 1
This is file 1.

@page file2 File 2
This is file 2.

@page file3 File 3
This is file 3.

这些注释当然可以包含在一个文件或多个文件中。通常，我会将文件放在@page file1file1.h、@page file2file2.h 等中，并将@subpage注释放在更顶级的头文件或主源文件中。

于 2011-06-17T00:06:05.933 回答