Contenu spécial
Les commandes de contenu du document identifient des parties de la documentation qui présentent un rendu particulier, une signification conceptuelle ou une fonction spécifique.
\quotation
Les commandes \quotation et \endquotation délimitent une longue citation.
Dans le code HTML généré, le texte du bloc délimité est encadré par les bal ises <blockquote> et </blockquote>, par exemple :
/*!
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
*/Le texte du \quotation bloc apparaîtra dans le code HTML généré sous la forme suivante :
<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 feuille de style intégrée à la plupart des navigateurs affichera le contenu de la balise <blockquote> avec des retraits à gauche et à droite. L'exemple ci-dessus s'afficherait comme suit :
À mesure que nos solutions étaient adoptées dans de nouveaux environnements, nous avons constaté un besoin croissant d’une intégration plus aisée avec un éventail plus large d’applications d’entreprise.
Mais vous pouvez redéfinir la balise <blockquote> dans votre fichier style.css.
\note
La commande \note définit un nouveau paragraphe précédé de « Note : » en gras. La commande prend un paragraphe continu comme argument et se termine à la fin de ce paragraphe. La commande note est réservée aux phrases courtes et ne convient pas aux longs paragraphes sur plusieurs lignes.
À l'instar de la \warning , la note sert à mettre en évidence des remarques brèves et importantes. Consultez les directives de rédaction Qt pour plus d’informations sur son utilisation.
\notranslate
La commande « \notranslate » indique que son argument ne doit pas être traduit lorsque le résultat généré est transmis à un service de traduction.
Autres commandes (\c, \tt) ont le même effet, mais « \notranslate » n’applique aucun formatage à son argument.
Cette commande a été introduite dans la version 6.10 de QDoc.
\brief
La commande \brief permet d’ajouter une description en une phrase de n’importe quelle commande de rubrique.
Ce bref texte sert à introduire la documentation de l’objet associé, ainsi que dans les listes générées à l’aide de la \generatelist commande et la \annotatedlist commande.
Le texte succinct s'affichera dans la documentation relative à ce sujet particulier.
Par exemple, la propriété booléenne « 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()
*/et la propriété « 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(), ...
*/Lorsque la commande « \brief » est utilisée pour décrire une classe, nous recommandons d’utiliser une phrase complète comme celle-ci :
The <classname> class is|provides|contains|specifies...Avertissement : ne répétezpas votre description détaillée en reprenant la même phrase, car le résumé constituera le premier paragraphe de la description détaillée.
/*!
\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
*/Utilisation de « \brief » dans un \namespace:
/*!
\namespace Qt
\brief The Qt namespace contains miscellaneous identifiers
used throughout the Qt library.
*/Utilisation de \brief dans 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>
*/Voir aussi \property, \class, \namespace et \headerfile.
\legalese
Les commandes « \legalese » et « \endlegalese » délimitent un contrat de licence.
Dans le code HTML généré, le texte délimité est encadré par les balises <div class="LegaleseLeft"> et </div>.
Exemple de contrat de licence encadré par les balises \legalese et \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
*/Il apparaîtra dans le code HTML généré sous la forme suivante :
<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 la commande \endlegalese est omise, QDoc traitera la commande \legalese mais considérera le reste de la page de documentation comme le contrat de licence.
Idéalement, le texte de la licence se trouve à proximité du code sous licence.
Ailleurs, la documentation identifiée par la \legalese peut être regroupée à l’aide de \generatelist en utilisant legalese comme argument. Cela est utile pour générer une vue d'ensemble des contrats de licence associés au code source.
Remarque : la sortie de la commande \generatelist legalese ne comprend que les textes de licence \legalese du projet de documentation actuel. Si le projet de documentation actuel dépend d’autres modules, leurs textes de licence ne seront pas répertoriés.
\warning
La commande \warning ajoute « Avertissement : » devant l'argument de la commande, en caractères gras.
/*!
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.
