The QDoc Configuration File

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 the minimum.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, e.g. 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 valuem string, e.g.:

 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