ステータス

これらのコマンドは、ドキュメント化された要素が何らかの特別なステータスを持っていることを示すためのものです。その要素は非推奨（deprecated）とマークされる可能性があります。つまり、廃止され、パブリック・インターフェースに含まれなくなろうとしています。また \sinceコマンドは、関数やクラスが最初に登場したバージョン番号を指定するためのものです。コマンドは \qmlabstractコマンドはQMLの型を抽象基底クラスとして指定します。

\abstract そして\qmlabstract

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

通常、QML型に \qmlabstractでマークされている場合は \internalでマークされます。抽象的なQML型に内部マークが付けられていない場合、ドキュメンテーションの中に参照ページが作成されます。

\attribution

\attribution 。 \pageをライセンス帰属文書としてマークします。

\generatelist annotatedattributionsコマンドは、文書化プロジェクトのすべてのライセンス帰属ページの注釈付きリストを生成します。

\default

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

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

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

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

\compares

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

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

• strong
• partial
• weak
• equality

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

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

以下も参照してください。 \compareswith.

\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

\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 タイプのリファレンスページを参照してください。

\qmlenumeratorsfrom

で\qmlenumeratorsfrom コマンドを使用します。 \qmlpropertyトピックで コマンドを使用します。 \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 コマンドは、特定のモジュールのdontdocument.qdocファイルでのみ使用される。このファイルは、ドキュメント化されることを意図していない、公に宣言されたクラスや構造体を指定します。QDocはこれらのクラスや構造体に対して、\class コメントが見つからないという警告を表示しません。

以下に、ウィジェット用のdontdocument.qdocの\dontdocument ：

/*!
   \dontdocument (QTypeInfo QMetaTypeId)
*/

\inheaderfile

\inheaderfile メタ・コマンドは、C++クラス、名前空間、ヘッダー・ファイルの参照ドキュメント用に生成されたinclude文をオーバーライドするために使用されます。

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

#include <SomeClass>

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

\class SomeClass
\inheaderfile Tools/SomeClass
...

参照 \classそして \headerfile.

\obsolete

\obsolete コマンドは\deprecated コマンドに取って代わられる。

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

また \deprecated.

\deprecated

\deprecated コマンドは、関連する要素が非推奨であり、新しいコードではもはや使用すべきではないことを示すためのものである。

\deprecated コマンドは2つのオプション引数を取る：

• 角括弧内のバージョン（例えば[6.2]）。
• より詳細な情報（例えば、推奨される置換など）を示す文字列。

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

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

\internal

\internal コマンドは、ドキュメント化された要素がパブリック・インターフェースの一部ではないことを示します。

このコマンドは、それ自身の行で立っていなければならない。

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 環境変数が設定されない限り、この関数はドキュメントに含まれません。

\modulestate

\module または\qmlmodule トピック内で\modulestate コマンドを使用して、カスタム・モジュールの状態説明を提供します。

このコマンドはモジュールの状態を記述する引数を取ります。例えば

/*!
    \module QtFoo
    \modulestate Experimental
*/

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

このモジュールは実験状態です。

HTML 出力では、この状態情報はモジュールのメンバーのリファレンスページのナビゲーションバー (パンくず) にも表示されます。

以下も参照してください。 \preliminary.

\preliminary

\preliminary コマンドは、文書化された要素がまだ開発中であることを示すためのものである。

このコマンドはそれ自身の行に記述する必要があります。

\preliminary コマンドは、ドキュメント内の通知へ展開し、リストに表示されたとき、その要素を暫定的なものとしてマークします。

/*!
    \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 コマンドは \qmlpropertyコマンドと併用されます。

\required

\required 。 \qmlpropertyコマンドと併用します。

プロパティシステム」も参照してください。

\since

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

\since に渡される引数にスペースが含まれていない場合、それは製品名の省略記法であるとみなされ、QDoc は生成される出力においてバージョンの前にproductname の値を付けます。変数productname が未定義の場合、QDoc はバージョン文字列のみを生成します。

引数には製品名を明示的に含めることもできます：

\since MyFramework 2.0

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

Since 情報の継承

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

以降

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

以下も参照してください。 \valueおよびignoresinceも参照してください。

\wrapper

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