En esta página

Marcado de texto

Los comandos de formato de texto indican cómo debe representarse el texto.

\a (marcador de parámetro)

El comando « \a » indica a QDoc que la siguiente palabra es el nombre de un parámetro formal.

Se emite una advertencia cuando un parámetro formal no está documentado o tiene un error ortográfico, por lo que, al documentar una función, debes mencionar cada parámetro formal por su nombre en la descripción de la función, precedido del comando \a. De este modo, el nombre del parámetro se muestra en cursiva.

El nombre del parámetro formal puede ir entre llaves, pero no es obligatorio.

\c (fuente de código)

El comando « \c » se utiliza para representar los nombres de variables, los nombres de clases definidas por el usuario y las palabras clave de C++ (por ejemplo, « int » y « for ») con la fuente de código.

El comando muestra su argumento utilizando una fuente monoespaciada. Si el texto que se va a mostrar con la fuente de código contiene espacios, hay que encerrar todo el texto entre llaves:

\c {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) : QWidget(parent)}

El comando « \c » acepta el carácter especial « \ » dentro de su argumento, lo que hace que se represente como un carácter normal. Por lo tanto, si quieres utilizar comandos anidados, debes utilizar en su lugar el comando «teletype» (\tt).

Véase también \tt y \code.

\details (plegable)

Los comandos « \details » y « \enddetails » generan un elemento <details> plegable con un <summary> para controlar el estado oculto o visible.

Al generar la salida HTML, utiliza los comandos « \details » y « \enddetails » para generar un elemento HTML <details> que se puede contraer. El comando admite una cadena de resumen opcional entre llaves. Este argumento opcional especifica un título visible para los detalles.

Si se omite el argumento, QDoc muestra «...» como cadena de resumen.

Por ejemplo, con la siguiente entrada:

/*!
    \details {QDoc details}
        \note You're looking at detailed information.
    \enddetails
*/

Si QDoc está generando HTML, traducirá estos comandos a:

<details>
  <summary>QDoc details</summary>
  <div class="admonition note">
    <p><b>Note: </b>You're looking at detailed information.</p>
  </div>
</details>

QDoc lo muestra así:

Detalles de QDoc

Nota: Estás viendo información detallada.

Para cualquier otro formato de salida, QDoc genera el contenido como un párrafo normal, ignorando la cadena de resumen. Este comando se introdujo en QDoc en Qt 6.6.

\div

Los comandos « \div » y « \enddiv » delimitan un bloque de texto grande o pequeño (que puede incluir otros comandos de QDoc) al que se deben aplicar atributos de formato especiales.

Se debe proporcionar un argumento entre llaves, tal y como se muestra en el comentario de QDoc que aparece a continuación. El argumento no se interpreta, sino que se utiliza como atributo(s) de la etiqueta que genera QDoc.

Por ejemplo, es posible que queramos mostrar una imagen en línea de forma que flote a la derecha del bloque de texto actual:

/*!
    \div {class="float-right"}
        \inlineimage qml-column.png
    \enddiv
*/

Si QDoc está generando HTML, traducirá estos comandos a:

<div class="float-right"><p><img src="images/qml-column.png" /></p></div>

En HTML, el valor del atributo «float-right» hará referencia a una cláusula del archivo style.css, que en este caso podría ser:

div.float-right
{
   float: right; margin-left: 2em
}

Nota: Ten en cuenta que el \div comando se puede anidar.

A continuación se muestra un ejemplo extraído del archivo index.qdoc utilizado para generar index.html para Qt 4.7:

\div {class="indexbox guide"}
    \div {class="heading"}
        Qt Developer Guide
\enddiv
    \div {class="indexboxcont indexboxbar"}
        \div {class="section indexIcon"} \emptyspan
        \enddiv
        \div {class="section"}
            Qt is a cross-platform application and UI
            framework. Using Qt, you can write web-enabled
            applications once and deploy them across desktop,
            mobile and embedded operating systems without
            rewriting the source code.
        \enddiv
        \div {class="section sectionlist"}
            \list
               \li \l{Getting Started}
               \li \l{Installation} {Installation}
               \li \l{how-to-learn-qt.html} {How to learn Qt}
               \li \l{tutorials.html} {Tutorials}
               \li \l{Qt Examples} {Examples}
               \li \l{qt4-7-intro.html} {What's new in Qt 4.7}
            \endlist
        \enddiv
    \enddiv
\enddiv

Cuando todos los valores de los atributos de clase se definen tal y como aparecen en el archivo style.css que se utiliza para generar la documentación de Qt, el ejemplo anterior se muestra así:

Guía del desarrollador de Qt

Qt es un marco de trabajo multiplataforma para aplicaciones e interfaces de usuario. Con Qt, puedes escribir aplicaciones web una sola vez e implementarlas en sistemas operativos de escritorio, móviles y embebidos sin necesidad de reescribir el código fuente.

  • Primeros pasos
  • Instalación
  • Cómo aprender a utilizar Qt
  • Tutoriales
  • Ejemplos
  • Novedades de Qt 4.7

Véase también \span.

\span

El comando « \span » aplica un formato especial a un pequeño bloque de texto.

Se deben proporcionar dos argumentos, cada uno de ellos entre llaves, tal y como se muestra en el comentario de QDoc que aparece a continuación. El primer argumento no se interpreta, pero especifica los atributos de formato de la etiqueta generada por QDoc. El segundo argumento es el texto que se va a representar con los atributos de formato especiales.

Por ejemplo, podríamos querer que la primera palabra de cada elemento de una lista numérica se mostrara en azul.

/*!
    Global variables with complex types:
\list 1
        \li \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
        \li \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
        \li \span {class="variableName"} {constComplex1} in globals.cpp at line 16
        \li \span {class="variableName"} {constComplex2} in globals.cpp at line 17
    \endlist
*/

La clase variableName hace referencia a una cláusula de tu archivo style.css.

.variableName
{
    font-family: courier;
color: blue
}

Al utilizar la cláusula «variableName» que se muestra arriba, el ejemplo se representa así:

Variables globales con tipos complejos:

  1. mutableComplex1 en globals.cpp, en la línea 14
  2. mutableComplex2 en globals.cpp, línea 15
  3. constComplex1 en globals.cpp, línea 16
  4. constComplex2 en globals.cpp, línea 17

Nota: El comando «span» no da lugar al inicio de un nuevo párrafo.

Véase también \div.

\tm (marca registrada)

El comando « \tm » indica que su argumento es una marca registrada. QDoc añade el símbolo de marca registrada «™» a la primera aparición del argumento al generar una página.

En la configuración del proyecto, la variable ` navigation.trademarkspage ` se utiliza para definir el título de una página que contiene documentación relacionada con marcas registradas.

navigation.trademarkspage = Trademarks

Si se establece, cada aparición del símbolo de marca registrada también enlaza con la página de marcas registradas.

Nota: En los títulos de las secciones, se ignora el comando \tm y su argumento se muestra tal cual.

Véase también \section1 y navigation.

\tt (fuente de teletipo)

El comando « \tt » muestra su argumento en una fuente monoespaciada. Este comando se comporta exactamente igual que el \c , salvo que « \tt » permite anidar comandos QDoc dentro del argumento (p. ej., \e, \b y \underline).

/*!
    After having populated the main container with
    child widgets, \c setupUi() scans the main container's list of
    slots for names with the form
    \tt{on_\e{objectName}_\e{signalName}().}
*/

Si el texto que se va a mostrar con la fuente del código contiene espacios, hay que escribirlo entre llaves.

\tt {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)}

Véase también \c.

\b

El comando « \b » muestra su argumento en negrita. Este comando solía llamarse « \bold ».

/*!
    This is regular text; \b {this text is
    rendered using the \\b command}.
*/

\br

El comando « \br » fuerza un salto de línea.

\e (énfasis, cursiva)

El comando « \e » muestra su argumento con una fuente especial, normalmente en cursiva. Este comando solía llamarse « \i », pero ahora está en desuso.

Si el argumento contiene espacios u otros signos de puntuación, hay que escribirlo entre llaves.

/*!
    Here, we render \e {a few words} in italics.
*/

Si quieres utilizar otros comandos de QDoc dentro de un argumento que contenga espacios, siempre debes encerrar el argumento entre llaves. Sin embargo, QDoc es lo suficientemente inteligente como para contar los paréntesis, por lo que no necesitas llaves en casos como este:

/*!
    An argument can sometimes contain whitespaces,
    for example: \e QPushButton(tr("A Brand New Button"))
*/

Por último, la puntuación final no se incluye en un argumento, ni tampoco el «'s».

\sub

El comando « \sub » hace que su argumento aparezca por debajo de la línea de base del texto normal, utilizando una fuente más pequeña.

/*!
    Definition (Range): Consider the sequence
    {x\sub n}\sub {n > 1} . The set

    {x\sub 2, x\sub 3, x\sub 4, ...} = {x\sub n ; n = 2, 3, 4, ...}

    is called the range of the sequence.
*/

Si el argumento contiene espacios u otros signos de puntuación, hay que ponerlo entre llaves.

\sup

El comando « \sup » hace que su argumento aparezca por encima de la línea de base del texto normal, utilizando una fuente más pequeña.

/*!
    The series

    1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...

    is called the \i {geometric series}.
*/

Si el argumento contiene espacios u otros signos de puntuación, hay que escribirlo entre llaves.

\uicontrol

El comando « \uicontrol » se utiliza para marcar contenido destinado a elementos de control de la interfaz de usuario. Cuando se utiliza HTML, el resultado se muestra en negrita.

Véase también \b.

\underline

El comando « \underline » muestra su argumento subrayado.

/*!
    The \underline {F}ile menu gives the users the possibility
    to edit an existing file, or save a new or modified
    file, and exit the application.
*/

Si el argumento contiene espacios u otros signos de puntuación, hay que escribirlo entre llaves.

\\ (doble barra invertida)

La secuencia \\ se expande como una sola barra invertida.

Los comandos de QDoc siempre comienzan con una sola barra invertida. Para mostrar una sola barra invertida en el texto, debes escribir dos barras invertidas. Si quieres mostrar dos barras invertidas, debes escribir cuatro.

/*!
    The \\\\ command is useful if you want a
    backslash to appear verbatim, for example,
    writing C:\\windows\\home\\.
*/

Sin embargo, si también quieres que tu texto aparezca en una fuente monoespaciada, puedes utilizar en su lugar el \c , que acepta y representa la barra invertida como cualquier otro carácter. Por ejemplo:

/*!
    The \\c command is useful if you want a
    backslash to appear verbatim, and the word
    that contains it written in a monospace font,
    like this: \c {C:\windows\home\}.
*/

-- (guión largo)

QDoc representa los guiones dobles como un guión corto. Los comandos de marcado de QDoc diseñados para que la entrada aparezca tal cual —como el comando \c — no sustituirán los guiones dobles por un carácter de guión corto. Por ejemplo:

/*!
    The \\c command -- useful if you want text in a monospace font --
    is well documented.
*/

Sin embargo, otros comandos pueden requerir que los guiones se escapen para garantizar que QDoc muestre el resultado tal y como se espera. Por ejemplo:

/*!
    This \l {endash-sequence}{link to the -- (endash) sequence}
    isn't escaped and QDoc therefore renders an endash in the link
    text. However, the escaped
    \l {endash-sequence}{link to the \-- (endash) sequence}
    renders both hyphens as intended.
*/

Advertencia: Evita utilizar el guion corto en los títulos de las secciones y las páginas. La creación de enlaces a un título puede fallar si este contiene caracteres especiales, como el guion corto.

Véase también --- (guión largo).

--- (guión largo)

QDoc muestra los tres guiones como un guión largo. Los comandos de marcado de QDoc diseñados para que la entrada aparezca tal cual —como el comando \c — no sustituyen los tres guiones por un carácter de guión largo. Por ejemplo:

/*!
    The \\c command---useful when you want text to be rendered
    verbatim---is well documented.
*/

Sin embargo, otros comandos pueden requerir que los guiones se escapen para garantizar que QDoc represente la salida tal y como se espera. Por ejemplo:

/*!
    This \l {emdash-sequence}{link to the --- (emdash) sequence}
    isn't escaped and QDoc therefore renders an emdash in the link
    text. However, the escaped
    \l {emdash-sequence}{link to the -\-- (emdash) sequence}
    renders both hyphens as intended.
*/

Nota: La secuencia de control escapada de este ejemplo corresponde al guión corto. De este modo se evita que en la salida aparezca un guión seguido de un guión corto.

Advertencia: Evita utilizar el guion largo en los títulos de las secciones y de las páginas. La creación de enlaces a un título puede fallar si este contiene caracteres especiales, como el guion largo.

Véase también -- (guión corto).

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