【发布时间】:2016-05-11 20:09:30
【问题描述】:
我有一个用 doxygen 记录的大型 C++ 软件应用程序。如何设置它以便为特定类生成子文档?这些类记录在源代码注释、它们自己的 .dox 文件和 images/ 目录中。我需要能够生成特定于单个类的独立 pdf 文件。
我可以使用分组来确定将包含在该子文档中的内容,但是如何为单个组生成输出?
【问题讨论】:
标签: c++ pdf latex doxygen doxygen-wizard
我有一个用 doxygen 记录的大型 C++ 软件应用程序。如何设置它以便为特定类生成子文档?这些类记录在源代码注释、它们自己的 .dox 文件和 images/ 目录中。我需要能够生成特定于单个类的独立 pdf 文件。
我可以使用分组来确定将包含在该子文档中的内容,但是如何为单个组生成输出?
【问题讨论】:
标签: c++ pdf latex doxygen doxygen-wizard
如果每个请求的输出实体都有一个特定的 .dox 文件,那么您需要做的就是在该文件中定义作为声明和定义该类的文件的输入。
例如,假设您只想要在文件myclass.hpp 中声明的类MyClass 的输出,并且其实现在myclass.cpp 中,然后在myclass.dox 中,只需添加以下内容:
INPUT = ./myclass.cpp \
./myclass.hpp
当然,.cpp 和 .hpp 可以有不同的路径。或者您可以记录多个课程。
然后,在 myclass.dox 文件上运行 doxygen。
还要注意输出文件夹名称。对于 html 输出,默认名称是 html,因此您可能需要重命名它以避免混淆所有不同的输出。例如,您可能希望在 dox 文件中添加如下内容:
HTML_OUTPUT = html_myclass
【讨论】: