文档错误"qdoc无法运行；qdocconf文件中没有设置项目“

Question

我正在尝试使用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而不是在终端中运行命令来创建文档吗？

Answer 1

不知何故，我发现您需要在.qdocconf文件中添加以下一行

project = YourProjectName

它不存在于https://doc.qt.io/qt-5/qdoc-minimum-qdocconf.html中显示的最小qdocconf文件中。尽管上述问题已得到解决，但也遇到了许多其他问题，例如：

1. 编译时，qt.qdoc: No include paths passed to qdoc; guessing reasonable include paths.为此，您必须手动包含所有源路径。读：https://bugreports.qt.io/browse/QTBUG-67289
2. 一些注释标记，例如\ QtCreator中的返回、\param不被QDoc识别

选项2

或者，寻找更易于使用的含氧，并使用简单易用的GUI生成文档。它还识别QtCreator中的所有注释标记。

更新：

的DO2插件不再工作了，因为支持已经过期了。直接使用GUI。