Contenido especial
Los comandos de contenido del documento identifican partes de la documentación, partes con una representación, un significado conceptual o una función especiales.
\quotation
Los comandos \quotation y \endquotation delimitan una cita larga.
El texto del bloque delimitado se rodea de <blockquote> y </blockquote> en la salida html, p. ej:
/*!
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 bloque \quotation 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 incorporada en la mayoría de los navegadores mostrará el contenido de la etiqueta <blockquote> con sangrías a izquierda y derecha. El ejemplo anterior se mostraría como:
A medida que nuestras soluciones se adoptaban en nuevos entornos, vimos una creciente necesidad de una integración más fácil con una gama más amplia de aplicaciones empresariales.
Pero puede redefinir la etiqueta <blockquote> en su archivo style.css.
\note
El comando \note define un nuevo párrafo precedido de "Nota:" en negrita. El comando toma como argumento un párrafo continuo, que termina tras el final del párrafo. El comando nota sólo sirve para frases cortas y no para párrafos más largos de varias líneas.
Al igual que el comando \warning la nota es para frases cortas e importantes. Consulte las Directrices de escritura de Qt para obtener información sobre su uso.
\notranslate
El comando \notranslate indica que su argumento no debe traducirse, cuando la salida generada se pasa a un servicio de traducción de idiomas.
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 frase de cualquiera de los Comandos Temáticos.
El breve texto se utiliza para introducir la documentación del objeto asociado, y en las listas generadas utilizando el comando \generatelist y el comando \annotatedlist comando.
El texto breve se mostrará en la documentación de ese tema en particular.
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, se recomienda utilizar una frase completa como ésta:
The <classname> class is|provides|contains|specifies...
Advertencia: No repita su descripción detallada con la misma frase, ya que la breve declaració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
*/Utilización 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 acuerdo de licencia.
En el HTML generado, el texto delimitado está rodeado por las etiquetas <div class="LegaleseLeft"> y </div>.
Un ejemplo de un acuerdo de licencia delimitado en \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 HTML generado como:
<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á el resto de la página de documentación como el acuerdo de licencia.
Idealmente, el texto de la licencia se encuentra con el código licenciado.
En caso contrario, la documentación identificada como \legalese puede acumularse utilizando \generatelist con legalese como argumento. Esto es útil para generar una visión general de los acuerdos de licencia asociados con el código fuente.
Nota: La salida del comando \generatelist legalese incluye los textos de \legalese sólo en el proyecto de documentación actual. Si el proyecto de documentación actual depende de otros módulos, sus textos de licencia no aparecerán en la lista.
\warning
El comando \warning añade "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.
