Navegación por documentos
Los comandos de navegación sirven para enlazar las páginas de un documento en una secuencia significativa. A continuación se muestra una secuencia de comentarios de QDoc que muestra un uso típico de los comandos de navegación.
Ejemplo
/*!
\page basicqt.html
\nextpage Getting Started
\indexpage Index
\startpage Basic Qt
\title Basic Qt
The Qt toolkit is a C++ class library and a set of tools for
building multiplatform GUI programs using a "write once,
compile anywhere approach".
Table of contents:
\list
\li \l {Getting Started}
\li \l {Creating Dialogs}
\li \l {Creating Main Windows}
\endlist
*/
/*!
\page gettingstarted.html
\previouspage Basic Qt
\nextpage Creating Dialogs
\indexpage Index
\startpage Basic Qt
\title Getting Started
This chapter shows how to combine basic C++ with the
functionality provided by Qt to create a few small graphical
interface (GUI) applications.
*/
/*!
\page creatingdialogs.html
\previouspage Getting Started
\indexpage Index
\startpage Basic Qt
\title Creating Dialogs
This chapter will teach you how to create dialog boxes using Qt.
*/
/*!
\page index.html
\indexpage Index
\startpage Basic Qt
\title Index
\list
\li \l {Basic Qt}
\li \l {Creating Dialogs}
\li \l {Getting Started}
\endlist
*/El comando \startpage crea un enlace a la página que el autor desea como primera página de un documento multipágina.
El enlace se incluye en el código fuente HTML generado, pero no tiene ningún efecto visual en la documentación:
<head> ... <link rel="start" href="basicqt.html" /> ... </head>
Comandos
\previouspage
El comando \previouspage enlaza la página actual con la página anterior en una secuencia. El comando tiene dos argumentos, cada uno encerrado entre llaves: el primero es el objetivo del enlace (el título de la página anterior), el segundo es el texto del enlace. Si el título de la página es equivalente al texto del enlace, el segundo argumento puede omitirse.
El comando debe ir solo en su propia línea.
\nextpage
El comando \nextpage enlaza la página actual con la siguiente en una secuencia. El comando sigue la misma sintaxis y convención de argumentos que el comando \previouspage .
\startpage
El comando \startpage especifica la primera página de una secuencia de páginas. El comando debe aparecer solo en su propia línea, y su único argumento es el título del primer documento.
QDoc generará un enlace a la página de inicio y lo incluirá en el archivo HTML generado, pero esto no tiene ningún efecto visual en la documentación. El tipo de enlace generado indica a los navegadores y motores de búsqueda qué documento considera el autor que es el punto de partida de la colección.
\toc
Los comandos \toc y \endtoc especifican una lista de subtemas (páginas) para el tema en el que aparece el comando. Se genera una jerarquía de tabla de contenidos (TOC) para todo el proyecto de documentación basada en las entradas TOC de cada tema.
Dentro del bloque \toc.. \endtoc, utilice comandos \tocentry para especificar los subtemas por título. Al igual que el comando \l (enlace), \tocentry toma un segundo argumento opcional para el título visible para el usuario en la entrada TOC generada.
/*!
\page index.html
\title Qt
...
\toc
\tocentry {Introduction to Qt} {Introduction}
\tocentry {What's new in Qt} {What's new}
\tocentry {Getting started}
\endtoc
*/\tocLos comandos no pueden anidarse. Sin embargo, cada subtema puede especificar sus propias entradas de TOC. Un tema sólo puede utilizar un comando \toc.
QDoc escribe la estructura resultante de la tabla de contenidos en formato XML en un archivo <project>_toc.xml.
Nota: El tema raíz (índice o página de destino) debe especificarse en la configuración del proyecto con navigation.landingpage o navigation.homepage. Consulte navigation para obtener más información.
El comando \toc se introdujo en QDoc con Qt 6.11.
Véase también \tocentry.
\tocentry
Especifica un subtema (página) como entrada en el índice. Sólo puede utilizarse dentro de un par de comandos \toc y \endtoc.
El comando \tocentry se introdujo en QDoc con Qt 6.11.
Véase también \toc.
© 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.
