关联事物

关联命令用于指定一个文档元素如何关联到另一个文档元素。以下是一些示例

此函数是另一个函数的重载。
此函数是另一个函数的重实现。
此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;
}

如果您不使用\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的参考页面上。

线程支持分组事物