Format-specific Configuration Variables
The format-specific configuration variables define the generated documentation's style, or define the contents of the documentation's footer or postheader.
Some of the configuration values are relevant only for the HTML output format and their values contain raw HTML.
HTML.footer
The HTML.footer variable defines the content of the generated HTML documentation's footer.
The footer is rendered at the bottom of the generated documentation page.
The variable's value is given as raw HTML code enclosed by quotation marks. Note that if the value spans several lines, each line needs to be enclosed by quotation marks.
HTML.footer = "<p /><address><hr /><div align=\"center\">\n" \
...
"</tr></table></div></address>"<FORMAT>.nosubdirs
A boolean value which, when true, enables single-directory output mode; all generated files go to FORMAT.outputsubdir directory, instead of a subdirectory based on the documentation project name.
<FORMAT>.outputsubdir
Defines the subdirectory under outputdir where documentation is generated.
HTML.nosubdirs = true HTML.outputsubdir = html
With above, the output goes to <outputdir>/html.
HTML.postheader
The HTML.postheader variable defines the content of the generated HTML documentation's postheader.
The header is rendered at the top of the generated documentation page, immediately after the opening <body> element.
The variable's value is given as raw HTML enclosed by quotation marks. Note that if the value spans several lines, each line needs to be enclosed by quotation marks.
After rendering the content of HTML.postheader, QDoc outputs the page's breadcrumb navigation as set of <li> elements. Therefore, postheader must end with a valid parent element for <li>, such as <ul>. The default value for HTML.postheader is
HTML.postheader = "<ul class=\"breadcrumb\">\n"
See also HTML.postpostheader.
HTML.postpostheader
The HTML.postpostheader variable defines the content that closes the HTML document's postheader and its enclosed list of navigation breadcrumb items. Its value must include the matching closing tag for the list element opened in HTML.postheader.
The default value for HTML.postpostheader is
HTML.postpostheader = "</ul>\n"
<FORMAT>.quotinginformation
A boolean value which, when true, generates references to quoted content (for example, \quotefromfile and \snippet commands) instead of including the content directly.
Used currently for the WebXML output format.
WebXML.quotinginformation = true
HTML.style
The HTML.style variable defines the style for the generated HTML documentation.
The variable's value is given as raw HTML enclosed by quotation marks. Note that if the value spans several lines, each line needs to be enclosed by quotation marks.
HTML.style = "h3.fn,span.fn" \
"{ margin-left: 1cm; text-indent: -1cm; }\n" \
"a:link { color: #004faf; text-decoration: none }\n" \
"a:visited" \
"{ color: #672967; text-decoration: none }\n" \
"td.postheader { font-family: sans-serif }\n" \
"tr.address { font-family: sans-serif }\n" \
"body { background: #ffffff; color: black; }"HTML.stylesheets
The HTML.stylesheets variable defines a list of stylesheets to use for the generated HTML documentation.
Using separate stylesheets for the documentation makes it easier to customize and experiment with the style used once the contents has been generated. Typically, it is only necessary to define a single stylesheet for any set of documentation; for example:
HTML.stylesheets = path/to/classic.css
QDoc expects to find stylesheets in the directory containing the qtgui.qdocconf file, and it will copy those specified to the output directory alongside the HTML pages.
<FORMAT>.tocdepth
The <FORMAT>.tocdepth variable defines how many document sections are printed in the table of contents. Setting tocdepth to 0 disables the table of contents while leaving it undefined prints all document sections.
Currently only has an effect for the HTML format:
HTML.tocdepth = 3
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
