使用Doxygen生成子文档

3
我有一个使用doxygen文档记录的大型C++软件应用程序。我该如何设置它,以便可以为特定类生成子文档?这些类使用源代码中的注释、自己的 .dox 文件和 images/ 目录进行了文档化。我需要能够生成一个独立的针对单个类的pdf文件。
我可以使用分组来标识将包含在该子文档中的内容,但是如何为单个组生成输出呢?
1个回答

1
如果每个请求的输出实体都有特定的.dox文件,那么您需要做的就是在该文件中定义输入为声明和定义该类的文件。例如,如果您想要仅针对在文件myclass.hpp中声明并在myclass.cpp中实现的类MyClass进行输出,则只需在myclass.dox中添加以下内容:
INPUT = ./myclass.cpp \
    ./myclass.hpp

当然,你可以为.cpp和.hpp文件设置不同的路径。或者你可以记录多个类。
然后,在那个myclass.dox文件上运行doxygen。
还要注意输出文件夹的名称。对于html输出,默认名称为“html”,因此您可能希望将其重命名以避免混淆所有不同的输出。例如,您可能希望在dox文件中添加以下内容:
HTML_OUTPUT = html_myclass

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接