如何解决文档错误“ qdoc无法运行; qdocconf文件中未设置任何项目”
我正在尝试使用QDoc为我的代码生成文档。 qtdoc
命令已经在我的环境变量路径中。但是,当我尝试在项目(qdocconf文件也位于项目根目录)的根目录中运行命令时,
qdoc projectname.qdocconf
我收到以下错误
qt.qdoc:“ qdoc无法运行;在qdocconf文件中未设置任何项目”
这是我的projectname.qdocconf
文件。
headers.fileextensions = "*.h *.hpp"
sources.fileextensions = "*.cpp *.qml *.qdoc"
outputdir = Documentation/Code
headerdirs += Code
sourcedirs += . \
Code
exampledirs = .
imagedirs += ./Images/icons \
./Images/logos
我已经按照文档中的格式对类函数进行了评论
/*!
* \fn void inlineFunction()
*
* Some info here...
*/
你能指出我在做什么吗?
还可以使用QtCreator创建文档,而不是在终端中运行命令吗?
解决方法
好吧,我发现您需要在 .qdocconf 文件中添加以下行
project = YourProjectName
在https://doc.qt.io/qt-5/qdoc-minimum-qdocconf.html中显示的最小qdocconf文件中不存在。即使上述问题已解决,也遇到了许多其他问题,例如:
- 在编译时,
qt.qdoc: No include paths passed to qdoc; guessing reasonable include paths
。为此,您必须手动包括所有源路径。阅读:https://bugreports.qt.io/browse/QTBUG-67289 - 一些评论标签,例如QtCreator中存在的\ return,\ param无法被QDoc识别
选项2
或者,查找Doxygen,它更易于使用,并通过易于使用的GUI生成文档。它还可以识别QtCreator中的所有注释标签。
更新:
由于支持已过期,用于Qt Creator的Doxygen插件不再起作用。直接使用Doxygen GUI。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。