Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Unable to generate qdoc documentations

Tags:

qt

By following this guide http://doc-snapshot.qt-project.org/qdoc/qdoc-guide-conf.html, I made a simple qdoc configuration file.

sourcedirs = ../sources

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

outputdir  =    ./doc/
outputformats = HTML

However, the generated documenation folder is empty, except for the index file and a couple of folders. folder captured

Can anyone help explain this? Thanks a lot!

like image 248
dudeking Avatar asked Oct 20 '22 02:10

dudeking


1 Answers

Let me answer my own question. I just figured out that setting sourcedirs is not enough. You need to set up headerdirs as well.

headerdirs = ../sources

This solves the issue. qdoc searches headers first and then searches for .cpp files for documentations. qdoc does not search for documentations in header files but it will need header files in order to find the source files.

like image 150
dudeking Avatar answered Oct 23 '22 23:10

dudeking