El archivo de configuración de QDoc
Antes de ejecutar QDoc, debes crear un archivo de configuración de QDoc para indicar a QDoc dónde encontrar los archivos fuente que contienen los comentarios de QDoc. La ruta de acceso a tu archivo de configuración se pasa a QDoc en la línea de comandos:
/current/dir$ ../../bin/qdoc ./config.qdocconf
Descripción general
El archivo de configuración es una lista de entradas con el formato «variable = valor». Mediante las variables de configuración, puedes definir dónde debe buscar QDoc los distintos archivos fuente, imágenes y ejemplos, dónde guardar la documentación generada, etc. El archivo de configuración también puede contener directivas como ` include`. Para ver un ejemplo, consulta `minimum.qdocconf`.
También puede utilizar variables de configuración para que QDoc admita proyectos derivados; es decir, QDoc puede generar enlaces en la documentación de su proyecto a elementos de la documentación en línea de Qt. Consulte la sección «Admisión de proyectos derivados ».
Un nombre válido de variable de configuración puede incluir letras mayúsculas y minúsculas, números y un guión bajo «_».
El valor de una variable de configuración se puede establecer utilizando «=» o «+=». La diferencia es que «=» sobrescribe el valor anterior, mientras que «+=» añade un nuevo valor al actual.
Los valores de algunas variables de configuración se interpretan como una lista de cadenas, por ejemplo: sourcedirs, mientras que otros se tratan como una sola cadena. Las comillas dobles alrededor de una cadena de valor son opcionales, pero incluirlas permite utilizar caracteres especiales como «=» y « " » dentro de la cadena de valor, por ejemplo:
HTML.postheader = "<ul class=\"breadcrumbs\">"Si una entrada ocupa varias líneas, utiliza una barra invertida al final de cada línea, excepto en la última:
sourcedirs = kernel tools widgetsEsto se puede escribir así:
sourcedirs = kernel \
tools \
widgetsSi un valor ocupa varias líneas pero se interpreta como una sola cadena, las líneas se unen con espacios.
Expansión de valores de configuración
QDoc admite la expansión de variables de entorno dentro de los archivos de configuración. Por ejemplo, los módulos Qt utilizan la variable de entorno QT_INSTALL_DOCS para incluir definiciones relacionadas con todos los proyectos de documentación de los módulos Qt:
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)Las variables que se van a expandir llevan el prefijo «$». Para utilizar el carácter literal «$» dentro de una cadena de valor, hay que escaparlo con una barra invertida: «\$».
Desde QDoc 6.0, los valores también se pueden expandir a partir de otras variables de configuración. Además de la sintaxis « $variable », también es válida la sintaxis « ${variable} ». Esta última elimina la necesidad de separar el nombre de la variable con espacios en blanco o caracteres que no sean de variable. Por ejemplo:
baseurl = https://doc.qt.io/
...
url = ${baseurl}qtcreatorSi la variable de destino hace referencia a una lista de cadenas, estas se unirán mediante espacios en el valor expandido:
vars = foo \
bar \
baz
items = "Items: $vars" # Expands to "Items: foo bar baz"También es posible controlar qué carácter se utiliza para unir la lista de cadenas:
items = "Items: ${vars,|}" # Expands to "Items: foo|bar|baz"
items = "Items: ${vars,,}" # Expands to "Items: foo,bar,baz"
items = "Items: ${vars,}" # Expands to "Items: foobarbaz"Dado que la expansión se realiza tras leer todas las variables, el orden en que se definen no importa.
Nota: No se admite la expansión de variablesanidadas .
Expansión de variables de entorno
Al expandir variables de entorno, la sintaxis « ${variable} » tiene un comportamiento diferente al de « $variable ». La primera expande el contenido de la variable en su lugar para que se analice como parte del archivo de configuración, mientras que la segunda simplemente asigna el contenido como valor de la variable de configuración actual. Esto tiene implicaciones si la variable de entorno contiene una lista de elementos separados por espacios en blanco u otro formato reconocido por QDoc.
Por ejemplo, si el valor de una variable de entorno SRCDIRS es "../src/a ../src/b", entonces
sourcedirs = $SRCDIRS # Fail - value is interpreted as a single path.
sourcedirs = ${SRCDIRS} # Ok - whitespace is used as a delimiter.Variables de configuración
Lista de variables
- define
- depende
- documentación en encabezados
- directorios de ejemplos
- ejemplos
- ruta de instalación de los ejemplos
- ejemplos.extensiones de archivo
- ejemplos.advertencia sobre imágenes que faltan
- ejemplos.advertir sobre archivos de proyecto que faltan
- carpetas excluidas
- archivos excluidos
- imágenes-adicionales
- falsedades
- directorios de encabezados
- encabezados
- extensiones de archivo de encabezados
- HTML.pie de página
- HTML.encabezado-de-entrada
- HTML.encabezado-después-de-la-entrada
- HTML.estilo
- rutas de inclusión
- incluir privado
- ignorewords
- ignoresince
- directorios_imágenes
- directorio de salida de imágenes
- índices
- idioma
- información de ubicación
- advertencias de registro
- macro
- metadatos del manifiesto
- encabezado del módulo
- navegación
- directorio de salida
- formatos_de_salida
- prefijos de salida
- sufijos de salida
- comentarios de parsecpp
- preliminar
- nombre del producto
- proyecto
- raíz del proyecto
- mostrar_documentación_autogenerada
- directorios de origen
- fuentes
- extensiones de archivo de las fuentes
- spurious
- tamaño de la tabulación
- url
- ejemplos de URL
- url.fuentes
- utilizartextalternocomotítulo
- versión
- símbolo de versión
- límite de advertencias
Categorías
Ejemplos de archivos de configuración
- Un archivo de configuración mínimo: minimum.qdocconf
- El archivo de configuración de Qt: qtgui.qdocconf
© 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.