The QDoc Configuration File

Before running QDoc, you must create a QDoc configuration file to tell QDoc where to find the source files that contain the QDoc comments. The pathname to your configuration file is passed to QDoc on the command line:

/current/dir$ ../../bin/qdoc ./config.qdocconf

General Description

The configuration file is a list of entries of the form "variable = value". Using the configuration variables, you can define where QDoc should find the various source files, images and examples, where to put generated documentation etc. The configuration file can also contain directives like include. For an example, see a minimal qdocconf file.

You can also use configuration variables to get QDoc to support derived projects, i.e QDoc can generate links in your project's documentation to elements in the Qt online documentation. See the Supporting Derived projects section.

The value of a configuration variable can be set using either '=' or '+='. The difference is that '=' overrides the previous value, while '+=' adds a new value to the current one.

Some configuration variables accept a list of strings as their value, for example: sourcedirs, while others accept only a single string. Double quotes around a value string are optional, but including them allows you to use special characters like '=' and ' " ' within the value string, for example:

 HTML.postheader = "<a href=\"index.html\">Home</a>"

If an entry spans many lines, use a backslash at the end of every line but the last:

 sourcedirs = kernel \
              tools \
              widgets

Configuration Variables

Variable List

• alias
• Cpp.ignoredirectives
• Cpp.ignoretokens
• defines
• depends
• exampledirs
• examples
• examples.fileextensions
• excludedirs
• excludefiles
• extraimages
• falsehoods
• headerdirs
• headers
• headers.fileextensions
• HTML.footer
• HTML.postheader
• HTML.style
• ignorewords
• ignoresince
• imagedirs
• images
• images.fileextensions
• indexes
• language
• locationinfo
• macro
• manifestmeta
• navigation
• outputdir
• outputformats
• outputprefixes
• outputsuffixes
• project
• sourcedirs
• sources
• sources.fileextensions
• spurious
• tabsize
• url
• url.examples
• version
• versionsym
• warninglimit

Categories

• Generic Configuration Variables
• C++ Specific Configuration Variables
• Format-specific Configuration Variables

Configuration File Examples

• A minimum configuration file: minimum.qdocconf
• The Qt configuration file: qtgui.qdocconf