QDoc配置运行后无法生成HTML文档问题求助
问题1解决说明
Qt 6 版本的QDoc强制要求配置project字段指定项目名称,你参考的最小配置示例对应Qt 5版本规则,Qt 6 下保留该字段即可正常运行,无额外副作用。
问题2解决步骤
仅生成index文件无HTML,是缺少3项必要配置和文档入口导致,按以下修改即可:
- 补充包含路径配置,在qdocconf文件中添加一行,解决日志中的无include路径告警:
includepaths = .
- 配置QDoc扫描cpp文件,默认规则下QDoc仅提取头文件注释,需添加配置指定扫描的源文件扩展名:
sources.fileextensions = "*.cpp *.h"
- 添加文档主入口注释,QDoc需要至少一个
\mainpage注释作为文档首页生成的依据,可直接在main.cpp开头添加如下内容:
/*! * \mainpage MyProject 说明文档 * 此处填写项目主页面的介绍内容,所有接口文档会自动关联到该页面的索引中。 */
修改完成后重新运行qdoc myproject.qdocconf,生成的所有HTML文件会存放在docs/html目录下,打开index.html即可查看完整文档。
内容的提问来源于stack exchange,提问作者Mark
相关产品推荐
相关产品推荐

