无法生成qdoc文档

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

让我回答我自己的问题。我刚意识到只设置资源是不够的。你也需要设置头巾。

headerdirs = ../sources

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

Answer 2

可以使用“跟踪”命令从项目中生成文档。

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

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

sourcedirs = ../sources

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

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