En esta página

Variables de configuración específicas del formato

Las variables de configuración específicas de formato definen el estilo de la documentación generada, o bien definen el contenido del pie de página o del encabezado de la documentación.

Algunos de los valores de configuración solo son relevantes para el formato de salida HTML y sus valores contienen código HTML sin procesar.

La variable HTML.footer define el contenido del pie de página de la documentación HTML generada.

El pie de página se muestra en la parte inferior de la página de documentación generada.

El valor de la variable se indica como código HTML sin formato entre comillas. Ten en cuenta que, si el valor ocupa varias líneas, cada línea debe ir entre comillas.

HTML.footer = "<p /><address><hr /><div align=\"center\">\n" \
              ...
              "</tr></table></div></address>"

<FORMAT>.nosubdirs

Un valor booleano que, cuando es true, habilita el modo de salida en un único directorio; todos los archivos generados se guardan en el directorio FORMAT.outputsubdir, en lugar de en un subdirectorio basado en el nombre del proyecto de documentación.

<FORMAT>.outputsubdir

Define el subdirectorio dentro de outputdir en el que se genera la documentación.

HTML.nosubdirs = true
HTML.outputsubdir = html

Con lo anterior, la salida se guarda en <outputdir>/html.

HTML.postheader

La variable HTML.postheader define el contenido del encabezado de la documentación HTML generada.

El encabezado se muestra en la parte superior de la página de documentación generada, inmediatamente después del elemento de apertura <body>.

El valor de la variable se indica como código HTML sin formato entre comillas. Ten en cuenta que, si el valor ocupa varias líneas, cada línea debe ir entre comillas.

Tras mostrar el contenido de HTML.postheader, QDoc genera la navegación por la ruta de navegación de la página como un conjunto de elementos <li>. Por lo tanto, postheader debe terminar con un elemento padre válido para <li>, como <ul>. El valor por defecto de HTML.postheader es

HTML.postheader = "<ul class=\"breadcrumb\">\n"

Véase también HTML.postpostheader.

HTML.postpostheader

La variable ` HTML.postpostheader ` define el contenido que cierra el encabezado de publicación del documento HTML y la lista de elementos de la ruta de navegación que contiene. Su valor debe incluir la etiqueta de cierre correspondiente al elemento de lista abierto en HTML.postheader.

El valor por defecto de ` HTML.postpostheader ` es

HTML.postpostheader = "</ul>\n"

<FORMAT>.quotinginformation

Un valor booleano que, cuando true, genera referencias al contenido entre comillas (por ejemplo, \quotefromfile y \snippet comandos) en lugar de incluir el contenido directamente.

Actualmente se utiliza para el formato de salida WebXML.

WebXML.quotinginformation = true

HTML.style

La variable HTML.style define el estilo de la documentación HTML generada.

El valor de la variable se indica como código HTML sin formato entre comillas. Ten en cuenta que, si el valor ocupa varias líneas, cada línea debe ir entre comillas.

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

La variable HTML.stylesheets define una lista de hojas de estilo que se utilizarán para la documentación HTML generada.

El uso de hojas de estilo independientes para la documentación facilita la personalización y la experimentación con el estilo una vez generado el contenido. Por lo general, solo es necesario definir una única hoja de estilo para cualquier conjunto de documentación; por ejemplo:

HTML.stylesheets = path/to/classic.css

QDoc espera encontrar las hojas de estilo en el directorio que contiene el archivo qtgui.qdocconf, y copiará las especificadas al directorio de salida junto con las páginas HTML.

<FORMAT>.tocdepth

La variable <FORMAT>.tocdepth define cuántas secciones del documento se incluyen en la tabla de contenidos. Si se establece tocdepth en 0, se desactiva la tabla de contenidos; si no se define, se incluyen todas las secciones del documento.

Actualmente solo tiene efecto en el formato HTML:

HTML.tocdepth = 3

© 2026 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.