c - 如何使用 Doxygen 组镜像 C 目录结构？

Question

我需要一些在 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？

Answer 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 file1 放在 file1.h 中，将 @page file2 放在 file2.h 中，等等，以及 @subpage 注释在更顶层的头文件或主源文件中。