Besonderer Inhalt
Die Befehle zum Dokumentinhalt kennzeichnen Teile der Dokumentation, die eine besondere Darstellung, konzeptionelle Bedeutung oder Funktion haben.
\Zitat
Die Befehle \quotation und \endquotation grenzen ein langes Zitat ab.
Der Text im abgegrenzten Block wird in der HTML-Ausgabe von <blockquote> und </blockquote> umgeben, 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 erscheint in der generierten HTML-Datei als:
<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>
Die in den meisten Browsern integrierte Formatvorlage stellt den Inhalt des <blockquote>-Tags mit linken und rechten Einzügen dar. Das obige Beispiel würde wie folgt wiedergegeben werden:
Als unsere Lösungen in neue Umgebungen übernommen wurden, erkannten wir einen zunehmenden Bedarf an einer einfacheren Integration mit einer breiteren Palette von Unternehmensanwendungen.
Sie können das <blockquote>-Tag jedoch in Ihrer style.css-Datei neu definieren.
\note
Der Befehl \note definiert einen neuen Absatz, dem ein fettgedrucktes "Note:" vorangestellt wird. Der Befehl nimmt einen fortlaufenden Absatz als Argument und endet nach dem Ende des Absatzes. Der Befehl note ist nur für kürzere Anweisungen und nicht für längere mehrzeilige Absätze geeignet.
Ähnlich wie der Befehl \warning ist der Hinweis für kurze und wichtige Anweisungen gedacht. Siehe Qt Writing Guidelines für Informationen zur Verwendung.
\Inhaltsverzeichnis
Der Befehl \tableofcontents wurde deaktiviert, da QDoc nun automatisch ein Inhaltsverzeichnis erzeugt.
Das automatisch generierte Inhaltsverzeichnis erscheint in der oberen rechten Ecke der Seite.
\brief
Mit dem Befehl \brief wird eine Ein-Satz-Beschreibung eines beliebigen Themenbefehls eingefügt.
Der kurze Text wird zur Einleitung der Dokumentation des zugehörigen Objekts und in Listen verwendet, die mit dem Befehl \generatelist und dem Befehl \annotatedlist erstellt werden.
Der Kurztext wird in der Dokumentation zu dem betreffenden Thema angezeigt.
Zum Beispiel die Eigenschaft boolean 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 verwendet wird, um eine Klasse zu beschreiben, empfehlen wir, einen vollständigen Satz wie diesen zu verwenden:
The <classname> class is|provides|contains|specifies...
Achtung! Wiederholen Sie Ihre ausführliche Beschreibung nicht mit demselben Satz, da die Kurzbeschreibung der erste Absatz der ausführlichen Beschreibung sein wird.
/*!
\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 \Namensraum:
/*! \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 grenzen eine Lizenzvereinbarung ab.
In der generierten HTML-Datei wird der abgegrenzte Text von den Tags <div class="LegaleseLeft"> und </div> umgeben.
Ein Beispiel für eine Lizenzvereinbarung, die in \legalese und \endlegalese eingeschlossen 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
*/Er erscheint im generierten HTML als:
<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>
Wenn der Befehl \endlegalese weggelassen wird, verarbeitet QDoc den Befehl \legalese, betrachtet aber den Rest der Dokumentationsseite als die Lizenzvereinbarung.
Idealerweise befindet sich der Lizenztext zusammen mit dem lizenzierten Code.
Andernorts kann die Dokumentation, die als \legalese-Befehl identifiziert wurde, mit \generatelist mit legalese als Argument akkumuliert werden. Dies ist nützlich, um einen Überblick über die mit dem Quellcode verbundenen Lizenzvereinbarungen zu erhalten.
Hinweis: Die Ausgabe des Befehls \generatelist legalese enthält nur die \legalese-Texte im aktuellen Dokumentationsprojekt. Wenn das aktuelle Dokumentationsprojekt von anderen Modulen abhängt, werden deren Lizenztexte nicht aufgeführt.
\Warnung
Der Befehl \warning stellt dem Argument des Befehls "Warning:" in fetter Schrift 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.
*/© 2025 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.
