peterO
19th June 2015, 13:32
Hi,
i currently try to use QDoc to generate documentation for a C++ project. I got it basically running, read the manual and got the basic concept, but there are a few things I am running in, that don't work as they should.
1. Linking doesnt work. I have a "\target abc" tag in one comment, and a "\l {abc} tag in another comment, and the qdoc.exe complains: "warning: Can't link to 'xyz'"
2. Inheritance doesn't work: I have some classes in C++ inheriting from one another. All classes a documented and somehow qdoc seems to notice, since it automatically creates a section "Inherits" onto the page of the class. But the section is empty, although there should be some classes in there (I did inherit as public, so that can't be the problem)
3. I cant use the \examples tag, although I did set the "exampledirs" variable in the qdocconf file. The qdoc.exe complains, that it can't find the file. But it definitely is there.
Here's the qdocconf I am using:
# QDoc is a tool that constantly evolves to suit our needs,
# and there are some compatibility issues between old and new
# practices. For that reason, any QDoc configuration file needs to
# include compat.qdocconf.
#include(compat.qdocconf)
# The outputdir variable specifies the directory
# where QDoc will put the generated documentation.
outputdir = html
# The headerdirs variable specifies the directories
# containing the header files associated
# with the .cpp source files used in the documentation.
headerdirs = ..
# The sourcedirs variable specifies the
# directories containing the .cpp or .qdoc
# files used in the documentation.
sourcedirs = .. \
doc/src
# The exampledirs variable specifies the directories containing
# the source code of the example files.
exampledirs = examples
# The imagedirs variable specifies the
# directories containing the images used in the documentation.
imagedirs = template\images
images.fileextensions += "*.jpg *.png"
# The fileextensions specify, which files qdoc should scan
# other files are just ignored.
sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml"
examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"
# Here some properties of the output HTML can be changes. For example a header and a footer
# can be added to customize the output to your needs.
HTML.templatedir = template
HTML.postheader = "<div id=\"postheader\" > <div id=\"logo\"><img src=\"images/logo.png\" /> </div> <h1> Frauenhofer CML - QDoc Project </h1> </div> "
HTML.headerstyles = "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/style.css\"/>"
Maybe you can point me on something that I might have to do additionally. Thanks already.
i currently try to use QDoc to generate documentation for a C++ project. I got it basically running, read the manual and got the basic concept, but there are a few things I am running in, that don't work as they should.
1. Linking doesnt work. I have a "\target abc" tag in one comment, and a "\l {abc} tag in another comment, and the qdoc.exe complains: "warning: Can't link to 'xyz'"
2. Inheritance doesn't work: I have some classes in C++ inheriting from one another. All classes a documented and somehow qdoc seems to notice, since it automatically creates a section "Inherits" onto the page of the class. But the section is empty, although there should be some classes in there (I did inherit as public, so that can't be the problem)
3. I cant use the \examples tag, although I did set the "exampledirs" variable in the qdocconf file. The qdoc.exe complains, that it can't find the file. But it definitely is there.
Here's the qdocconf I am using:
# QDoc is a tool that constantly evolves to suit our needs,
# and there are some compatibility issues between old and new
# practices. For that reason, any QDoc configuration file needs to
# include compat.qdocconf.
#include(compat.qdocconf)
# The outputdir variable specifies the directory
# where QDoc will put the generated documentation.
outputdir = html
# The headerdirs variable specifies the directories
# containing the header files associated
# with the .cpp source files used in the documentation.
headerdirs = ..
# The sourcedirs variable specifies the
# directories containing the .cpp or .qdoc
# files used in the documentation.
sourcedirs = .. \
doc/src
# The exampledirs variable specifies the directories containing
# the source code of the example files.
exampledirs = examples
# The imagedirs variable specifies the
# directories containing the images used in the documentation.
imagedirs = template\images
images.fileextensions += "*.jpg *.png"
# The fileextensions specify, which files qdoc should scan
# other files are just ignored.
sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml"
examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"
# Here some properties of the output HTML can be changes. For example a header and a footer
# can be added to customize the output to your needs.
HTML.templatedir = template
HTML.postheader = "<div id=\"postheader\" > <div id=\"logo\"><img src=\"images/logo.png\" /> </div> <h1> Frauenhofer CML - QDoc Project </h1> </div> "
HTML.headerstyles = "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/style.css\"/>"
Maybe you can point me on something that I might have to do additionally. Thanks already.