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

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

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

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