Variables de configuración específicas del formato
Las variables de configuración específicas del formato definen el estilo de la documentación generada, o definen el contenido del pie de página o del postitular de la documentación.
Algunos de los valores de configuración sólo son relevantes para el formato de salida HTML y sus valores contienen HTML sin procesar.
HTML.pie
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. Tenga en cuenta que si el valor abarca varias líneas, cada una de ellas debe ir entre comillas.
HTML.footer = "<p /><address><hr /><div align=\"center\">\n" \
...
"</tr></table></div></address>"<FORMAT>.nosubdirs
Un valor booleano que, cuando true, activa el modo de salida en un solo directorio; todos los archivos generados van al directorio FORMAT.outputsubdir, en lugar de a un subdirectorio basado en el nombre del proyecto de documentación.
<FORMAT>.outputsubdir
Define el subdirectorio bajo outputdir donde se genera la documentación.
HTML.nosubdirs = true HTML.outputsubdir = html
Con lo anterior, la salida va a <outputdir>/html.
HTML.postheader
La variable HTML.postheader define el contenido del postheader de la documentación HTML generada.
La cabecera 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 HTML sin formato entre comillas. Tenga en cuenta que si el valor abarca varias líneas, cada una de ellas debe ir entre comillas.
Después de renderizar el contenido de HTML.postheader, QDoc muestra la 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 para 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 la cabecera posterior del documento HTML y su lista adjunta de elementos de migas de pan de navegación. Su valor debe incluir la etiqueta de cierre correspondiente para el 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 citado (por ejemplo, \quotefromfile y \snippet comandos) en lugar de incluir el contenido directamente.
Se utiliza actualmente para el formato de salida WebXML.
WebXML.quotinginformation = true
HTML.estilo
La variable HTML.style define el estilo de la documentación HTML generada.
El valor de la variable se indica como HTML sin formato entre comillas. Tenga en cuenta que si el valor abarca varias líneas, cada una de ellas 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; }"Hojas.estilo.HTML
La variable HTML.stylesheets define una lista de hojas de estilo a utilizar para la documentación HTML generada.
El uso de hojas de estilo separadas para la documentación facilita la personalización y la experimentación con el estilo utilizado una vez generado el contenido. Normalmente, sólo 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 hojas de estilo en el directorio que contiene el archivo qtgui.qdocconf, y copiará las especificadas en el directorio de salida junto con las páginas HTML.
<FORMATO>.tocdepth
La variable <FORMAT>.tocdepth define cuántas secciones del documento se imprimen en el índice. Establecer tocdepth en 0 desactiva la tabla de contenidos, mientras que si se deja sin definir se imprimen todas las secciones del documento.
Actualmente sólo tiene efecto para 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.
