c++ - 使用 doxygen 生成子文档

Question

我有一个用 doxygen 记录的大型 C++ 软件应用程序。如何设置它以便为特定类生成子文档？这些类记录在源代码注释、它们自己的 .dox 文件和 images/ 目录中。我需要能够生成特定于单个类的独立 pdf 文件。

我可以使用分组来确定将包含在该子文档中的内容，但是如何为单个组生成输出？

Answer 1

如果每个请求的输出实体都有一个特定的 .dox 文件，那么您需要做的就是在该文件中定义作为输入声明和定义该类的文件。

举例来说，您只想要一个MyClass在文件中声明myclass.hpp且其实现在 in中的类的输出myclass.cpp，然后在 in 中myclass.dox，只需添加以下内容：

INPUT = ./myclass.cpp \
    ./myclass.hpp

当然，.cpp 和.hpp 可以有不同的路径。或者您可以记录多个课程。

myclass.dox然后，在该文件上运行 doxygen 。

还要注意输出文件夹名称。对于 html 输出，默认名称是html因此您可能希望重命名它以避免混淆所有不同的输出。例如，您可能希望在 dox 文件中添加如下内容：

HTML_OUTPUT = html_myclass