使用doxygen生成子文档

Question

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

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

Answer 1

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

例如，假设您只想要在文件MyClass中声明的类myclass.hpp的输出，其实现位于myclass.cpp，然后在myclass.dox中，只需添加此项：

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

当然，您可以为.cpp和.hpp设置不同的路径。或者您可以记录多个班级。

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

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

HTML_OUTPUT = html_myclass