QDoc支持派生项
在Qt文档生成工具QDoc的帮助下,我们可以很容易地为Qt项目生成漂亮的文档。但是,有时我们可能需要为派生项目或基于Qt的应用程序生成文档。幸运的是,QDoc支持这些场景,并可以轻松为您的派生项目生成文档。
首先,需要确保您已经正确地配置了QDoc,以便它可以访问您的派生项目。这可以通过在QDoc命令行中使用 -I 参数来实现,例如:
qdoc -I /path/to/my/derived/project -outputdir /path/to/output/dir /path/to/my/derived/project/sources
接下来,您需要设置 QDoc 的 “root” 参数,该参数指定您的派生项目的根目录。例如:
-D root=/path/to/my/derived/project
这将告诉QDoc从哪里开始处理文件,并为您的派生项目生成正确的相对链接。
最后,您需要指定要包括在文档中的文件和类。这可以通过使用 -input 参数和您希望包含的类和文件的名称或通配符来完成。例如:
-input /path/to/my/derived/project/src/*.cpp \
-input /path/to/my/derived/project/include/mylib/*.h \
-input /path/to/my/