Besondere Inhalte
Die Befehle für den Dokumentinhalt kennzeichnen Teile der Dokumentation, die eine besondere Darstellung, konzeptionelle Bedeutung oder Funktion haben.
\quotation
Die Befehle „ \quotation “ und „ \endquotation “ begrenzen ein langes Zitat.
Der Text im abgegrenzten Block wird in der HTML-Ausgabe von <blockquote> und </blockquote> umschlossen, z. B.:
/*!
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
*/Der Text im \quotation Block wird im generierten HTML wie folgt angezeigt:
<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>Das integrierte Stylesheet der meisten Browser rendert den Inhalt des <blockquote>-Tags mit Einrückungen links und rechts. Das obige Beispiel würde wie folgt dargestellt werden:
Als unsere Lösungen in neue Umgebungen übernommen wurden, stellten wir einen steigenden Bedarf an einer einfacheren Integration mit einer breiteren Palette von Unternehmensanwendungen fest.
Sie können das <blockquote> -Tag jedoch in Ihrer style.css-Datei neu definieren.
\note
Der Befehl „ \note “ definiert einen neuen Absatz, dem „Hinweis:“ in Fettschrift vorangestellt ist. Der Befehl nimmt einen zusammenhängenden Absatz als Argument und endet nach dem Ende des Absatzes. Der Befehl „note“ ist nur für kürzere Aussagen gedacht und nicht für längere, mehrzeilige Absätze.
Ähnlich wie der \warning Befehl dient „note“ für kurze und wichtige Aussagen. Informationen zur Verwendung finden Sie in den Qt-Schreibrichtlinien.
\notranslate
Der Befehl „ \notranslate “ gibt an, dass sein Argument nicht übersetzt werden soll, wenn die generierte Ausgabe an einen Sprachübersetzungsdienst weitergeleitet wird.
Andere Befehle (\c, \tt) haben denselben Effekt, aber ` \notranslate ` nimmt keinerlei Formatierung des Arguments vor.
Dieser Befehl wurde in QDoc Version 6.10 eingeführt.
\brief
Der Befehl „ \brief “ fügt eine einzeilige Beschreibung eines beliebigen Themenbefehls ein.
Der kurze Text dient als Einleitung zur Dokumentation des zugehörigen Objekts sowie in Listen, die mit dem \generatelist Befehls und des \annotatedlist Befehl generiert werden.
Der Kurztext wird in der Dokumentation zu diesem bestimmten Thema angezeigt.
Beispielsweise die boolesche Eigenschaft „ 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()
*/und die Eigenschaft „ 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(), ...
*/Wenn der Befehl „ \brief “ zur Beschreibung einer Klasse verwendet wird, empfehlen wir, einen vollständigen Satz wie diesen zu verwenden:
The <classname> class is|provides|contains|specifies...Warnung: WiederholenSie Ihre ausführliche Beschreibung nicht mit demselben Satz, da die kurze Beschreibung den ersten Absatz der ausführlichen Beschreibung bildet.
/*!
\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
*/Verwendung von „ \brief “ in einem \namespace:
/*!
\namespace Qt
\brief The Qt namespace contains miscellaneous identifiers
used throughout the Qt library.
*/Verwendung von „ \brief “ in einem \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>
*/Siehe auch \property, \class, \namespace und \headerfile.
\legalese
Die Befehle „ \legalese “ und „ \endlegalese “ begrenzen eine Lizenzvereinbarung.
Im generierten HTML-Code wird der abgegrenzte Text von den Tags <div class="LegaleseLeft"> und </div> umschlossen.
Ein Beispiel für eine Lizenzvereinbarung, die von den Tags ` \legalese ` und ` \endlegalese` umschlossen ist:
/*!
\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
*/Im generierten HTML-Code erscheint dies wie folgt:
<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>Wird der Befehl „ \endlegalese “ weggelassen, verarbeitet QDoc zwar den Befehl „ \legalese “, betrachtet jedoch den Rest der Dokumentationsseite als Lizenzvereinbarung.
Idealerweise befindet sich der Lizenztext zusammen mit dem lizenzierten Code.
An anderer Stelle kann die als \legalese mit dem Befehl \generatelist mit dem Argument „ legalese “ zusammengefasst werden. Dies ist nützlich, um einen Überblick über die mit dem Quellcode verbundenen Lizenzvereinbarungen zu erstellen.
Hinweis: Die Ausgabe des Befehls „ \generatelist legalese “ enthält ausschließlich die Texte unter \legalese aus dem aktuellen Dokumentationsprojekt. Wenn das aktuelle Dokumentationsprojekt von anderen Modulen abhängt, werden deren Lizenztexte nicht aufgeführt.
\warning
Der Befehl „ \warning “ fügt dem Argument des Befehls in fetter Schrift den Text „Warnung:“ voran.
/*!
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.
