使用 doxygen 生成文档

【问题标题】：Generating documentation with doxygen使用 doxygen 生成文档
【发布时间】：2014-05-01 22:04:14
【问题描述】：

我想用 doxygen 为 C++ 文件生成文档。当所有 *.h 和 *.cpp 文件都存储在一个文件夹中时，一切都很好。然后我输入

doxygen -g doxygenfile

然后

doxygen doxygenfile

毕竟我有一个 Latex 文件夹和一个 html 文件夹。一切都是好的。问题是当这些文件 *.h *.cpp 存储在不同的位置时，例如： *.h 在 H 文件夹中 *.cpp 在 CPP 文件夹中等等。有人可以告诉我在这种情况下如何生成文档吗？

【问题讨论】：

【解决方案1】：

如果您想要一个 GUI 来调整 Doxygen 的工作方式，您可以使用 doxywizard 并打开生成的 Doxyfile。

为了让 doxygen 查看子目录，您可以在 Doxyfile 中更改这一行

RECURSIVE              =

与

RECURSIVE              = YES

编辑：正如 Bornruffians 指出的那样，Doxygen 在 INPUT 设置中指定的目录中查找源文件（总是在 Doxyfile 中）。因此，您可以通过编写类似的内容来指定 INPUT 标记中的每个目录

INPUT = "src/CPP" "src/H"

并关闭 RECURSIVE 标签。您还可以将单个文件作为 INPUT 标记的值。

【讨论】：

如果要选择特定目录进行递归，请使用 Doxyfile 中的 INPUT 标签。或者，您可以将每个文件夹放在 INPUT 标签中并关闭 RECURSIVE；当你有很多文件夹时，这很乏味。
将 INPUT 与文件列表一起使用确实很乏味，但如果您希望文档中的内容按特定顺序排列，则可能是必要的。