En esta página

Creación de archivos de proyecto de ayuda

Descripción general

Qt Assistant utiliza un sistema de gestión de la documentación de Qt que requiere QDoc para generar listados de archivos.

QDoc permite utilizar variables de configuración para especificar qué páginas se deben incluir en cada conjunto de documentación que genera. Estas se especifican como subvariables de la variable « qhp », y cada conjunto se declara utilizando un identificador único como subvariable.

Por ejemplo, el archivo de configuración del conjunto de documentación « Qt Quick » especifica información sobre el conjunto como subvariables con el prefijo « qhp.QtQuick »:

qhp.projects = QtQuick

qhp.QtQuick.file                = qtquick.qhp
qhp.QtQuick.namespace           = org.qt-project.qtquick.$QT_VERSION_TAG
qhp.QtQuick.virtualFolder       = qtquick
qhp.QtQuick.indexTitle          = Qt Quick
qhp.QtQuick.indexRoot           =

qhp.QtQuick.subprojects         = qmltypes classes examples

qhp.QtQuick.subprojects.qmltypes.title = QML Types
qhp.QtQuick.subprojects.qmltypes.indexTitle = Qt Quick QML Types
qhp.QtQuick.subprojects.qmltypes.selectors = qmltype
qhp.QtQuick.subprojects.qmltypes.sortPages = true

qhp.QtQuick.subprojects.classes.title = Classes
qhp.QtQuick.subprojects.classes.title = C++ Classes
qhp.QtQuick.subprojects.classes.indexTitle = Qt Quick C++ Classes
qhp.QtQuick.subprojects.classes.selectors = class headerfile
qhp.QtQuick.subprojects.classes.sortPages = true

qhp.QtQuick.subprojects.examples.title = Examples
qhp.QtQuick.subprojects.examples.indexTitle = Qt Quick Examples and Tutorials
qhp.QtQuick.subprojects.examples.selectors = example

El conjunto de documentación puede incluir uno o varios subproyectos, que se añaden a la tabla de contenidos con el nombre especificado por title. La página de la documentación a la que hace referencia indexTitle actúa como página de índice del subproyecto. Los tipos de página que se incluirán en el subproyecto se especifican mediante selectors. Las entradas se ordenan alfabéticamente si sortPages se establece en true.

Uso de selectores

La propiedad selectors especifica qué tipos de página aparecen en la entrada de la tabla de contenidos de un subproyecto. Se pueden indicar varios selectores, separados por espacios en blanco.

Nota: Si un subproyecto no define la propiedad « selectors », se incluyen por defecto todas las páginas del proyecto.

SelectorDescripción
namespaceEspacios de nombres
classClases
exampleEjemplos
externalpageEntradas de páginas externas
functionFunciones
headerfileArchivos de cabecera
pagePáginas de resumen
propertyPropiedades de C++
typedefTipos «typedef» de C++
typealiasAlias de tipos en C++
variableVariables de C++
qmlpropertyPropiedades de QML
qmltypeTipos de QML
qmlvaluetypeTipos de valor en QML
module[:name]Módulos de C++ o miembros del módulo con un nombre especificado.
qmlmodule[:name]Módulos QML o miembros del módulo con un nombre especificado.
group[:groupname]Páginas de documentación para los miembros de un grupo especificado, tal y como se añaden mediante el \ingroup grupo. Se pueden enumerar varios nombres de grupo en una lista separada por comas.
noneNo selecciona nada; solo se genera un enlace a indexTitle. (Introducido en QDoc 6.9).

Por ejemplo, la siguiente configuración seleccionaría páginas de ejemplo y páginas que incluyeran el comando \ingroup tutorials:

qhp.QtQuickControls.subprojects = examples
qhp.QtQuickControls.subprojects.examples.title = Examples and Tutorials
qhp.QtQuickControls.subprojects.examples.indexTitle = Qt Quick Controls Examples
qhp.QtQuickControls.subprojects.examples.selectors = example group:tutorials
qhp.QtQuickControls.subprojects.examples.sortPages = true

Añadir una tabla de contenidos

Para crear una tabla de contenidos para un manual, crea un subproyecto con la propiedad « type » y configúrala como « manual ». La página de la documentación a la que hace referencia la propiedad « indexTitle » debe contener una lista de enlaces que actúe como tabla de contenidos para todo el manual. QDoc tomará la información de esta lista y creará una tabla de contenidos para el subproyecto.

Por ejemplo, el archivo de configuración de Qt Creator define un único subproyecto para su documentación, que incluye toda la documentación en un único manual:

qhp.QtCreator.subprojects = manual
qhp.QtCreator.subprojects.manual.title = Qt Creator Manual
qhp.QtCreator.subprojects.manual.indexTitle = All topics
qhp.QtCreator.subprojects.manual.type = manual

En este ejemplo, la página titulada «Todos los temas» contiene una lista anidada de enlaces a páginas de la documentación que se duplica en la pestaña «Índice» de Qt Assistant.

Un ejemplo de dicha estructura de lista:

/*!
    \page qtcreator-toc.html
    \title All topics

    \list
        \li \l {Installation}
        \li \l {Getting started}
        \list
            \li \l {Configuring Qt Creator}
            \li \l {Building and running an example}
        \endlist
        \li \l {Overview}
        \li \l {Tutorials}
            \generatelist tutorials
        ...
    \endlist
*/

Arriba, el tema «Introducción» tiene dos páginas como subtemas. El tema «Tutoriales » es una \group página, y el \generatelist comando para enumerar páginas de tutoriales individuales (miembros del grupo tutorials ) como sus subtemas.

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