Unsolved QDoc produces empty directory
-
I'm trying to generate my first QDoc output. To test it, right now I have only one comment in main.cpp:
/*! * \brief main * \param argc * \param argv * \return * * bla bla bla */ int main(int argc, char *argv[]) { // ...
Here my config file:
#include(compat.qdocconf) #include(fileextensions.qdocconf) project = MyProject outputdir = docs outputformats = HTML headerdirs = . sourcedirs = . exampledirs = . imagedirs = ./images
- in the minimum example the project field is not present. But without it, running
qdoc myproject.qdocconf
I get:
qt.qdoc: "qdoc can't run; no project set in qdocconf file"
- with the project field set, this is the output:
qt.qdoc: Start qdoc for MyProject in dual process mode: generate phase.
qt.qdoc: No include paths passed to qdoc; guessing reasonable include paths
(qdoc) Could not find the module header in include paths for module "MyProject" (include paths: QList() )
Artificial module header built from header dirs in qdocconf file
qt.qdoc: Parse source files for "MyProject"
qt.qdoc: Source files parsed for "MyProject"
qt.qdoc: End qdoc for MyProject in dual process mode: generate phase.I'm not sure how to include paths. Here I cannot find such an include command. It creates the output docs directory but it's almost empty: just the myproject.index file is there.
What I have to do further to produce the HTML files?
- in the minimum example the project field is not present. But without it, running
-
qdoc is considered to be an internal tool of Qt, it is only intended to generate Qt documentation.
If you want to generate docs for your project, use doxygen instead. It is considered the standard tool for documenting Qt projects. Uses the same syntax as qdoc.
-
Ah ok, it should be stated more clear in the documentation... it seems a "built-in" tool to create documentation for Qt-based projects.
-
You're right, it can be confusing!