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

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

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

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

Команды

\inherits

Команда \inherits предназначена для документирования наследования одного типа 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. Основная версия должна быть полностью документирована. Каждая перегрузка может иметь любые дополнительные сведения, предназначенные только для этой перегрузки.

Вы можете включить имя функции с '()', как параметр команды \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()

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

См. также 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.