ステータス

これらのコマンドは、文書化された要素が何らかの特別な状態にあることを示すためのものです。つまり、その要素は廃止され、パブリック・インターフェイスに含まれなくなろうとしています。関数やクラスが最初に登場したバージョン番号を指定します。 を抽象ベースクラスとしてマークするためのコマンドです。

\を指定します。

\abstractは "abstract "コマンドの同義語です。QML型を抽象ベース・タイプとしてのみ使用する場合は、このコマンドをQML型のコ メントに追加してください。QML型が抽象的であるということは、そのQML型がインスタンス化できないことを意 味します。その代わりに、その型のパブリックAPIに含まれるプロパティは、抽象QML型を継承する各QML型のリファレンスページのパブリックプロパティリストに記載されています。そのプロパティはあたかも継承したQML型のプロパティであるかのように記述されます。

通常、あるQML型に「 \qmlabstract 」というマークが付けられると、そのQML型のリ ファレンス・ページが生成されないように、そのQML型にも「\internal 」というマークが付けられます。抽象QML型がinternalとマークされていない場合、ドキュメントに参照ページがあります。

\属性

attribution "コマンドは、文書化された \pageをライセンス帰属文書としてマークします。

を表示します。

\デフォルト

QMLプロパティのデフォルト値を文書化するために使用します。このコマンドは引数を1つ取り、その引数がデフォルト値としてドキュメントに表示されます。

/*!
    \qmlproperty real Item::x
    \default 0.0
*/

デフォルト値が空でない文字列の場合は、引用符で囲んでください：

/*!
    \qmlproperty string Item::state
    \default "invalid"
*/

\比較

\compares コマンドを使用して、ドキュメント化された C++ 型をそれ自身と比較したときの比較結果を記述します。このコマ ンドは、"compares "コマンドと組み合わせて使用する必要があります。

\compares は以下の引数のいずれかを取ります：

• strong
• partial
• weak
• equality

strong partial weak equality は、型が等しいかどうかだけを比較することを意味します。

このコマンドはQt 6.7でQDocに導入されました。

compareswithも参照してください。

\比較

文書化された C++ 型を他の型と比較したときの比較結果を記述するには、\compareswith .. \endcompareswith コマンドのペアを使用します。\compareswith は 2 つ以上の引数を取ります: 比較カテゴリとそれに続く型名、またはスペースで区切られた型名のリストです。\compareswith と\endcompareswith コマンドの間にあるテキスト行は、比較カテゴリ引数の対象となるすべての型に適用される詳細とみなされます。

unsigned long のように、名前に1つ以上のスペースが含まれる型は、中括弧で囲む必要がある。

例えば

/*!
    ...
    \compareswith strong int long {unsigned long} {unsigned int} char
    ...
    \endcompareswith
    ...
*/

中括弧で囲まれた引数は、先頭と末尾の空白が取り除かれる。例えば、unsigned long とunsigned long は等価である。

比較カテゴリーの引数は以下のいずれかでなければならない：

• strong
• partial
• weak
• equality

strong partial と は順序に関係します。 は型が等しいかどうかだけ比較されることを意味します。weak equality

このコマンドはQt 6.7でQDocに導入されました。

comparesも参照してください。

\qmldefault

QMLプロパティをデフォルト・プロパティとしてマークするコマンドです。プロパティのドキュメントにはdefault と表示されます。

/*!
    \qmlproperty list<Change> State::changes
    This property holds the changes to apply for this state.
    \qmldefault

    By default, these changes are applied against the default state. If the state
    extends another state, then the changes are applied against the state being
    extended.
*/

QDocがこのプロパティをどのように表示するかについては、State タイプのリファレンス・ページを参照してください。

\から

プロパティ・タイプが列挙型であるトピックで 〚QDoc〛 コマンドを使用します。 \qmlpropertyを使用すると、C++ トピックから列挙子のドキュメントを自動的に複製できます。 \enumトピックから列挙子のドキュメントを自動的に複製します。

このコマンドは、完全修飾された C++ 列挙型を引数として取り、列挙子とその説明のリストを生成します。

デフォルトでは、各列挙子にはそのプロパティが属する型名が前置され、. がセパレーターとして使用されます。

例えば

/*!
    \qmlproperty enumeration QtMultimedia::Camera::error
    \qmlenumeratorsfrom QCamera::Error

    //! Outputs documentation for 'Camera.NoError', 'Camera.CameraError'
*/

列挙子が別の型名でQMLに登録されている場合、この名前（接頭辞）は角括弧内のオプション引数で指定することができます：

    \qmlenumeratorsfrom [Errors] QCamera::Error

    //! Outputs documentation for 'Errors.NoError', 'Errors.CameraError'
\1/

このコマンドはQDoc 6.8で導入されました。

このコマンドはQDoc 6.8で導入されました。 \qmlproperty, \enumおよび \value.

\ドキュメント

.dontdocumentコマンドは、特定のモジュールのdontdocument.qdocファイルでのみ使用されます。このファイルは、ドキュメント化されることを意図していない、公に宣言されたクラスや構造体を指定します。QDoc は、これらのクラスや構造体に対して欠落している \class コメントに関する警告を表示しません。

以下に、ウィジェット用のdontdocument.qdocにある୧⃛(๑⃙⃘⁼̴̀꒳⁼̴́๑⃙⃘)

/*!
   \dontdocument (QTypeInfo QMetaTypeId)
*/

\を参照してください。

C++クラス、名前空間、またはヘッダーファイル参照ドキュメント用に生成されたinclude文 を上書きするために使用されます。

デフォルトでは、QDocは以下のinclude文で\class SomeClass ：

#include <SomeClass>

実際のinclude文がデフォルトと異なる場合は、次のように文書化できます。

\class SomeClass
\inheaderfile Tools/SomeClass
...

を参照してください。

\削除

obsolete "コマンドは "obsolete "コマンドに取って代わられました。

このコマンドは後方互換性のためだけに残されています。将来のバージョンのQDocでは削除される可能性があります。代わりに ⅳdeprecatedコマンドを使用してください。

を参照してください。

\非推奨

を指定するためのコマンドです。ライブラリにいつまで残るかは保証されていません。

(2)非推奨コマンドは2つのオプション引数を取ります：

• 角括弧内のバージョン（例えば[6.2]）。
• (例: [6.2])角括弧で囲まれたバージョン。

クラスのリファレンス・ドキュメントを生成する際、QDoc は非推奨関数をドキュメント化した別個のページを作成し、リンクします。代替案として同等の関数を提案するのは良い習慣です。

/*!
    \fn MyClass::MyDeprecatedFunction
    \deprecated [6.2] Use MyNewFunction() instead.
*/

\内部

参照された関数がパブリックインターフェースの一部でないことを示す。

このコマンドは独立した行でなければなりません。

QDocは、関連するクラス・リファレンス・ドキュメントを生成するときに、ドキュメント化された項目と同様にドキュメントを無視します。

/*!
    \internal

    Tries to find the decimal separator. If it can't find
    it and the thousand delimiter is != '.' it will try to
    find a '.';
*/
int QDoubleSpinBoxPrivate::findDelimiter
        (const QString &str, int index) const
{
    int dotindex = str.indexOf(delimiter, index);
    if (dotindex == -1 && thousand != dot && delimiter != dot)
        dotindex = str.indexOf(dot, index);
    return dotindex;
}

QDocが-showinternal コマンドラインオプションで呼び出されるか、QDOC_SHOW_INTERNAL 環境変数が設定されない限り、この関数はドキュメントに含まれません。

\モジュールステート

この関数は、QDoc に コマンドラインオプションを付けて呼び出すか、 環境変数が設定されていない限り、ドキュメントには含まれません。

行の残りは、モジュールの状態を記述する引数として受け取られます。例えば

/*!
    \module QtFoo
    \modulestate Technical Preview
*/

QDocはこの情報をモジュールページに追加します：

このモジュールは技術プレビュー状態です。

HTML出力では、この状態情報はモジュールのメンバーの参照ページのナビゲーションバー（パンくず）にも表示されます。

\暫定

参照されている関数がまだ開発中であることを示すためのコマンドです。

このコマンドはそれ自身の行で立っていなければなりません。

The \preliminary command expands to a notification in the function documentation, and marks the function as preliminary when it appears in lists.

/*!
    \preliminary

    Returns information about the joining type attributes of the
    character (needed for certain languages such as Arabic or
    Syriac).

*/
QChar::JoiningType QChar::joiningType() const
{
    return QChar::joiningType(ucs);
}

\readonly

readonly "コマンドは、"readonly "コマンドと組み合わせて使用し、QMLプロパ ティを読み取り専用としてマークします。

\必須

QMLプロパティをrequiredとしてマークするために、￤requiredコマンドは￤qmlpropertyコマンドと一緒に使用されます。

The Property Systemも参照してください。

\を参照してください。

Ȃsinceコマンドは、関連する機能がどのマイナーリリースで追加されたかを示します。

を先頭に付けて出力します。引数にはプロジェクト名を明示的に含めることもできます：

\since MyFramework 2.0

この場合、引数（projectとversion）はそのまま使用されます。

Since 情報の継承

QDocバージョン6.5以降、C++クラスやQML型は、型ドキュメントで明示的に "since "が 使用されていない限り、それぞれのモジュールや QMLモジュールから"since "を継承します。

Since 節

valueコマンドでは、コマンド文字列の直後に角括弧で囲まれたオプションのsince句を指定できます。これは、特定の C++ 列挙型の値に since 情報を付けるために使用します。

また、ignoresinceも参照してください。

\ラッパー

C++クラス・ドキュメントで使用すると、そのクラスを非Qt APIへのアクセスを提供するラッパーとしてマークします。このコマンドは、そのようなクラスのメンバに対して生成される可能性のある警告を抑制するために使用されます。