En esta página

Contenido especial

Los comandos de contenido del documento identifican partes de la documentación que tienen una presentación especial, un significado conceptual o una función específica.

\quotation

Los comandos « \quotation » y « \endquotation » delimitan una cita extensa.

El texto del bloque delimitado queda entre <blockquote> y </blockquote> en el código HTML resultante, por ejemplo:

/*!
  Although the prospect of a significantly broader market is
  good news for Firstlogic, the notion also posed some
  challenges. Dave Dobson, director of technology for the La
  Crosse, Wisconsin-based company, said:

  \quotation
     As our solutions were being adopted into new
     environments, we saw an escalating need for easier
     integration with a wider range of enterprise
     applications.
  \endquotation
*/

El texto del \quotation bloque aparecerá en el HTML generado como:

<blockquote>
  <p>As our solutions were being adopted into new environments,
  we saw an escalating need for easier integration with a wider
  range of enterprise applications.</p>
</blockquote>

La hoja de estilo integrada en la mayoría de los navegadores mostrará el contenido de la etiqueta <blockquote> con sangrías a la izquierda y a la derecha. El ejemplo anterior se mostraría así:

A medida que nuestras soluciones se iban adoptando en nuevos entornos, observamos una necesidad cada vez mayor de facilitar la integración con una gama más amplia de aplicaciones empresariales.

Pero puedes redefinir la etiqueta <blockquote> en tu archivo style.css.

\note

El comando \note define un nuevo párrafo precedido por «Nota:» en negrita. El comando toma como argumento un párrafo continuo y termina al final de dicho párrafo. El comando «note» solo sirve para frases cortas y no para párrafos largos de varias líneas.

Al igual que el \warning , la nota sirve para declaraciones breves e importantes. Consulta las Directrices de redacción de Qt para obtener información sobre su uso.

\notranslate

El comando « \notranslate » indica que su argumento no debe traducirse cuando el resultado generado se envía a un servicio de traducción.

Otros comandos (\c, \tt) tienen el mismo efecto, pero « \notranslate » no aplica ningún estilo a su argumento.

Este comando se introdujo en la versión 6.10 de QDoc.

\brief

El comando \brief introduce una descripción de una sola frase de cualquiera de los comandos de tema.

El texto breve se utiliza para introducir la documentación del objeto asociado y en las listas generadas mediante el \generatelist comando y el \annotatedlist comando.

El texto breve aparecerá en la documentación correspondiente a ese tema concreto.

Por ejemplo, la propiedad booleana « QWidget::isWindow »:

/*!
   \property QWidget::isActiveWindow
   \brief Whether this widget's window is the active window.

   The active window is the window that contains the widget that
   has keyboard focus.

   When popup windows are visible, this property is \c true
   for both the active window \e and the popup.

   \sa activateWindow(), QApplication::activeWindow()
*/

y la propiedad « QWidget::geometry »

/*!
   \property QWidget::geometry
   \brief The geometry of the widget relative to its parent and
   excluding the window frame.

   When changing the geometry, the widget, if visible,
   receives a move event (moveEvent()) and/or a resize
   event (resizeEvent()) immediately.

   ...

  \sa frameGeometry(), rect(), ...
*/

Cuando se utiliza el comando « \brief » para describir una clase, recomendamos emplear una frase completa como esta:

The <classname> class is|provides|contains|specifies...

Advertencia: No repitas la descripción detallada con la misma frase, ya que la breve descripción será el primer párrafo de la descripción detallada.

/*!
   \class PreviewWindow
   \brief The PreviewWindow class is a custom widget
          displaying the names of its currently set
          window flags in a read-only text editor.

   The PreviewWindow class inherits QWidget. The widget
   displays the names of its window flags set with the
   setWindowFlags() function. It is also provided with a
   QPushButton that closes the window.

   ...

   \sa QWidget
*/

Uso de « \brief » en un \namespace:

/*!
   \namespace Qt

   \brief The Qt namespace contains miscellaneous identifiers
   used throughout the Qt library.
*/

Uso de \brief en un \headerfile:

/*!
   \headerfile <QtGlobal>
   \title Global Qt Declarations

   \brief The <QtGlobal> header file provides basic
   declarations and is included by all other Qt headers.

   \sa <QtAlgorithms>
*/

Véase también \property, \class, \namespace y \headerfile.

\legalese

Los comandos « \legalese » y « \endlegalese » delimitan un contrato de licencia.

En el código HTML generado, el texto delimitado queda entre las etiquetas y /div.

Un ejemplo de un acuerdo de licencia incluido entre \legalese y \endlegalese:

/*!
    \legalese
        Copyright 1996 Daniel Dardailler.

        Permission to use, copy, modify, distribute, and sell this
        software for any purpose is hereby granted without fee,
        provided that the above copyright notice appear in all
        copies and that both that copyright notice and this
        permission notice appear in supporting documentation, and
        that the name of Daniel Dardailler not be used in
        advertising or publicity pertaining to distribution of the
        software without specific, written prior permission. Daniel
        Dardailler makes no representations about the suitability of
        this software for any purpose. It is provided "as is"
        without express or implied warranty.

        Modifications Copyright 1999 Matt Koss, under the same
        license as above.
    \endlegalese
*/

Aparecerá en el código HTML generado de la siguiente manera:

<div class="LegaleseLeft">
   <p>Copyright 1996 Daniel Dardailler.</p>
   <p>Permission to use, copy, modify, distribute, and sell
   this software for any purpose is hereby granted without fee,
   provided that the above copyright notice appear in all
   copies and that both that copyright notice and this
   permission notice appear in supporting documentation, and
   that the name of Daniel Dardailler not be used in
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission. Daniel
   Dardailler makes no representations about the suitability of
   this software for any purpose. It is provided "as is"
   without express or implied warranty.</p>

   <p>Modifications Copyright 1999 Matt Koss, under the same
   license as above.</p>
</div>

Si se omite el comando « \endlegalese », QDoc procesará el comando « \legalese », pero considerará que el resto de la página de documentación constituye el acuerdo de licencia.

Lo ideal es que el texto de la licencia se incluya junto con el código bajo licencia.

En caso contrario, la documentación identificada como \legalese se puede recopilar utilizando \generatelist utilizando « legalese » como argumento. Esto resulta útil para generar una visión general de los acuerdos de licencia asociados al código fuente.

Nota: El resultado del comando « \generatelist legalese » incluye únicamente los textos de \legalese del proyecto de documentación actual. Si el proyecto de documentación actual depende de otros módulos, los textos de sus licencias no aparecerán en la lista.

\warning

El comando ` \warning ` antepone «Advertencia:» al argumento del comando, en negrita.

/*!
   Qt::HANDLE is a platform-specific handle type
   for system objects. This is  equivalent to
   \c{void *} on Windows and macOS, and to
   \c{unsigned long} on X11.

   \warning Using this type is not portable.
*/

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