无法生成idoc文档

Question

按照本指南http://doc-snapshot.qt-project.org/qdoc/qdoc-guide-conf.html，我制作了一个简单的qdoc​​配置文件。

sourcedirs = ../sources

sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"

outputdir  =    ./doc/
outputformats = HTML

但是，生成的文档文件夹为空，但索引文件和几个文件夹除外。

任何人都可以帮忙解释一下吗？非常感谢！

Answer 1

让我回答我自己的问题。我只是想通知设置sourcedirs是不够的。你也需要设置标题。

headerdirs = ../sources

这解决了这个问题。 qdoc首先搜索标头，然后搜索.cpp文件以获取文档。 qdoc不会在头文件中搜索文档，但它需要头文件才能找到源文件。

Answer 2

您可以使用follow命令从项目中生成文档。

C:\Qt\Qt5.3.1\...\bin\qdoc.exe your.qdocconf

但是您必须在配置文件的根文件夹上执行此命令。因为配置文件中的所有路径都取决于该文件夹。

sourcedirs = ../sources

或者您可以在qdoc命令中传递配置文件的绝对路径。

并且QDoc不会在.h文件中查找QDoc注释。因此，您必须在.cpp或.qdoc文件中编写文档注释。