物事の関連付け
関連コマンドは、ある文書化された要素が別の文書化された要素とどのように関連するかを指定するためのものです。いくつかの例があります：
- この関数は他の関数のオーバーロードである。
- この関数は他の関数の再実装である。
- このtypedefはあるクラスやヘッダーファイルと関連している。
QMLの型が他のQMLの型を継承していることを示すコマンドもあります。
コマンド
\継承
あるQML型が他のQML型を継承していることを示すコマンドです。このコマンドは、継承されるエレメントの 〚QMLtype〛コメントの中に含まれていなければなりません。引数は継承するQML型の名前です。
/*!
\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 はこの行をPauseAnimation 要素のリファレンス・ページに含めます：
\オーバーロード
overloadコマンドは、関数がその名前の2次オーバーロードであることを示すためのものです。このコマンドはそれ自身の行になければなりません。このコマンドが実際のオーバーロードでない関数と一緒に使われた場合、ノーオペとみなされます。
オーバーロードされた関数名(コンストラクタを除く)に対して、QDocはその関数の1つのプライマリ・バージョンと、"overload "コマンドでマークされた他のすべてのバージョンを想定しています。プライマリ・バージョンは完全に文書化されている必要があります。各オーバーロードは、そのオーバーロードされたバージョンだけのために追加したい余分なドキュメントを持つことができます。
このコマンドは、関数のプライマリバージョンのドキュメントへのリンクを持つ標準的なThis function overloads...行のテキストを含めます。完全修飾名 (QMenu::addAction() など) または非修飾名 (addAction() など) を使用できます。非修飾関数名を使用すると、QDoc は自動的に親クラス名またはネームスペース名を使用して修飾します。例えば、addAction() は、QMenu クラス・ドキュメント内で使用されると、QMenu::addAction() になります。
/*!
\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は、"This function overloads... "行の代わりに、プライマリ・バージョンのドキュメンテーションへのリンクを表示します：
これはオーバーロードされたメンバ関数です。
.
\レインプ
ⅳreimp コマンドは、関数が仮想関数の再実装であることを示すコマンドです。
デフォルトでは、QDocは再実装された仮想関数がドキュメント化されていない限り、クラス参照から省きます。このコマンドを使うことで、ドキュメント化されていない関数を確実にクラスに含めることができます。
このコマンドはそれ自身の行に記述する必要があります。
/*!
\reimp
*/
void QToolButton::nextCheckState()
{
Q_D(QToolButton);
if (!d->defaultAction)
QAbstractButton::nextCheckState();
else
d->defaultAction->trigger();
}この関数はドキュメントには含まれません。代わりに、基本関数QAbstractButton::nextCheckState() へのリンクがドキュメントに記載される。
\関連
relationates "コマンドは、クラス、ネームスペース、またはヘッダー・ファイルに対する実 体（関数、マクロ、typedef、enum、または変数）のドキュメントを含めるためのものです。引数は、実体が関連するクラス、ネームスペース、またはヘッダーの名前です。
引数がテンプレート化された型を参照する場合は、型名のみを使用します（テンプレート・パラメータは使用しません）。
/*!
\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 のリファレンス・ページにあります。
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
