Dinge in Beziehung setzen

Mit den Befehlen zum Zuordnen können Sie angeben, wie ein dokumentiertes Element mit einem anderen dokumentierten Element in Beziehung steht. Einige Beispiele:

• Diese Funktion ist eine Überladung einer anderen Funktion.
• Diese Funktion ist eine Reimplementierung einer anderen Funktion.
• Dieses Typedef steht in Beziehung zu einer Klasse oder Header-Datei.

Es gibt auch einen Befehl, um zu dokumentieren, dass ein QML-Typ einen anderen QML-Typ erbt.

Befehle

\Erben

Der Befehl \inherits dient dazu, zu dokumentieren, dass ein QML-Typ einen anderen QML-Typ erbt. Er muss in den \qmltype-Kommentar des vererbenden Elements aufgenommen werden. Das Argument ist der Name des geerbten QML-Typs.

/*!
    \qmltype PauseAnimation
    \nativetype QDeclarativePauseAnimation
    \ingroup qml-animation-transition
    \since 4.7
    \inherits Animation
    \brief The PauseAnimation element provides a pause for an animation.

    When used in a SequentialAnimation, PauseAnimation is a step
    when nothing happens, for a specified duration.

    A 500ms animation sequence, with a 100ms pause between two animations:

    SequentialAnimation {
        NumberAnimation { ... duration: 200 }
        PauseAnimation { duration: 100 }
        NumberAnimation { ... duration: 200 }
    }

    \sa {QML Animation and Transitions}, {declarative/animation/basics}{Animation basics example}
*/

QDoc fügt diese Zeile in die Referenzseite für das Element PauseAnimation ein:

Vererbt Animation

\overload

Der Befehl \overload zeigt an, dass eine Funktion eine sekundäre Überladung ihres Namens ist.

Der Befehl muss in einer eigenen Zeile stehen.

Für einen Funktionsnamen, der überladen ist (außer Konstruktoren), erwartet QDoc eine primäre Version der Funktion und alle anderen, die mit dem \overload-Befehl markiert sind. Die primäre Version sollte vollständig dokumentiert sein. Jede Überladung kann jede zusätzliche Dokumentation haben, die Sie nur für diese überladene Version hinzufügen möchten.

Sie können den Funktionsnamen plus '()' als Parameter an den Befehl \overload übergeben, der eine Standardtextzeile Diese Funktion überlädt... mit einem Link zur Dokumentation für die primäre Version der Funktion enthält.

/*!
    \overload addAction()

    This convenience function creates a new action with an
    \a icon and some \a text. The function adds the newly
    created action to the menu's list of actions, and
    returns it.

    \sa QWidget::addAction()
*/
QAction *QMenu::addAction(const QIcon &icon, const QString &text)
{
    QAction *ret = new QAction(icon, text, this);
    addAction(ret);
    return ret;
}

Wenn Sie den Funktionsnamen nicht in den Befehl \overload aufnehmen, erhalten Sie anstelle der Zeile "Diese Funktion überlädt..." mit dem Link zur Dokumentation für die primäre Version die alte Standardzeile:

Dies ist eine überladene Mitgliedsfunktion, die der Einfachheit halber bereitgestellt wird.

.

\reimp

Mit dem Befehl \reimp wird angegeben, dass eine Funktion eine Neuimplementierung einer virtuellen Funktion ist.

Der Befehl muss in einer eigenen Zeile stehen.

QDoc lässt die reimplementierte Funktion in der Klassenreferenz weg.

/*!
    \reimp
*/
void QToolButton::nextCheckState()
{
    Q_D(QToolButton);
    if (!d->defaultAction)
        QAbstractButton::nextCheckState();
    else
        d->defaultAction->trigger();
}

Diese Funktion wird nicht in die Dokumentation aufgenommen. Stattdessen wird in der Dokumentation ein Verweis auf die Basisfunktion QAbstractButton::nextCheckState() erscheinen.

\relates

Der Befehl \relates dient dazu, die Dokumentation einer Entität (eine Funktion, ein Makro, ein Typedef, ein Enum oder eine Variable) in eine Klasse, einen Namespace oder eine Header-Datei aufzunehmen. Das Argument ist der Name der Klasse, des Namespaces oder des Headers, auf den sich die Entität bezieht.

Wenn sich das Argument auf einen Schablonentyp bezieht, verwenden Sie nur den Typnamen (ohne Schablonenparameter).

/*!
    \relates QChar

    Reads a char from the stream \a in into char \a chr.

    \sa {Format of the QDataStream operators}
*/
QDataStream &operator>>(QDataStream &in, QChar &chr)
{
    quint16 u;
    in >> u;
    chr.unicode() = ushort(u);
    return in;
}

Die Dokumentation für diese Funktion ist auf der Referenzseite für die Klasse QChar enthalten, die unter dem Abschnitt Verwandte Nichtmitglieder aufgeführt ist.