Связывание элементов

Команды связывания предназначены для указания взаимосвязей между документированными элементами. Вот несколько примеров:

• Эта функция является перегрузкой другой функции.
• Эта функция является повторной реализацией другой функции.
• Этот typedef связан с некоторым классом или заголовочным файлом.

Также есть команда для документирования наследования QML-типа от другого QML-типа.

Команды

\inherits

Команда \inherits предназначена для документирования того, что один QML-тип наследуется от другого QML-типа. Она должна быть включена в комментарии элемента-наследника в \qmltype. Аргументом является имя наследуемого QML-типа.

/ *!
    \qmltype PauseAnimation
    \instantiates 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 включает эту строку на странице справки для элемента PauseAnimation:

Наследует Animation

\overload

Команда \overload используется для обозначения того, что функция является дополнительной перегрузкой своего имени.

Команда должна находиться на отдельной строке.

Для имени функции, которая перегружена (кроме конструкторов), QDoc ожидает одну основную версию функции, а все остальные помечаются командой \overload. Основная версия должна быть полностью задокументирована. Каждая перегрузка может иметь любые дополнительные сведения, которые вы хотите добавить для этой конкретной перегруженной версии.

Начиная с Qt 4.5, вы можете включить имя функции плюс '()' в качестве параметра команды \overload, что добавит стандартную строку Эта функция перегружает... со ссылкой на документацию основной версии функции.

/ *!
    \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;
}

QDoc отображает это так:

QAction * QMenu::addAction ( const QIcon & icon, const QString & text )

Эта функция перегружает addAction()

Эта вспомогательная функция создает новое действие с иконкой и некоторым текстом. Функция добавляет созданное действие в список действий меню и возвращает его.

См. также QWidget::addAction().

Если вы не включаете имя функции в команде \overload, вместо строки "Эта функция перегружает..." со ссылкой на документацию основной версии, вы получите стандартную строку:

Это перегруженный член-функция, предоставленный для удобства.

.

\reimp

Команда \reimp используется для обозначения того, что функция является повторной реализацией виртуальной функции.

Команда должна находиться на отдельной строке.

QDoc опустит переопределенную функцию из справочника класса.

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

Эта функция не будет включена в документацию. Вместо этого в документации появится ссылка на базовая функция QAbstractButton::nextCheckState().

\relates

Команда \relates используется для включения документации глобального элемента в какой-либо класс или заголовочный файл. Аргументом является имя класса или заголовочного файла.

/ *!
    \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;
}

Документация этой функции будет включена на странице справки для класса QChar.