상태

이 명령은 문서화된 요소에 특별한 상태가 있음을 나타내는 데 사용됩니다. 해당 요소는 사용 중단, 즉 더 이상 사용되지 않고 더 이상 공개 인터페이스에 포함되지 않는 것으로 표시될 수 있습니다. 명령은 \since 명령은 함수나 클래스가 처음 등장한 버전 번호를 지정하는 데 사용됩니다. 그리고 \qmlabstract 명령은 QML 유형을 추상 기본 클래스로 표시하는 데 사용됩니다.

\abstract 및 \qmlabstract

\abstract는 \qmlabstract 명령의 동의어입니다. 이 명령은 해당 유형이 추상 기본 유형으로만 사용되어야 하는 경우 \qmltype 주석에 추가하면 해당 유형이 추상적인 기본 유형으로만 사용되도록 할 수 있습니다. QML 유형이 추상적이라는 것은 인스턴스화할 수 없는 QML 유형을 의미합니다. 대신 해당 공개 API의 속성은 추상 QML 유형을 상속하는 각 QML 유형에 대한 참조 페이지의 공개 속성 목록에 포함됩니다. 이러한 속성은 상속하는 QML 유형의 속성인 것처럼 문서화됩니다.

일반적으로 QML 유형에 \qmlabstract로 표시되어 있으면 \internal 로 표시되어 참조 페이지가 생성되지 않습니다. 추상 QML 유형이 내부로 표시되지 않은 경우 문서에 참조 페이지가 생성됩니다.

\attribution

\attribution 명령은 문서화된 \page 를 라이선스 속성 문서로 표시합니다.

\generatelist annotatedattributions 명령은 문서 프로젝트에 있는 모든 라이선스 속성 페이지의 주석이 달린 목록을 생성합니다.

\default

\default 명령은 QML 속성의 기본값을 문서화하는 데 사용됩니다. 이 명령은 문서에 기본값으로 표시되는 단일 인수를 받습니다.

/*!
    \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

\compareswith .. \endcompareswith 명령 쌍을 사용하여 문서화된 C++ 유형을 다른 유형과 비교할 때 비교 결과를 설명합니다. \compareswith 비교 범주와 유형 이름 또는 공백으로 구분된 유형 이름 목록 등 두 개 이상의 인수를 받습니다. \compareswith 와 \endcompareswith 명령 사이의 모든 텍스트 줄은 비교 범주 인수가 적용되는 모든 유형에 적용되는 추가 세부 정보로 간주됩니다.

unsigned long 과 같이 이름에 하나 이상의 공백이 있는 유형은 중괄호로 묶어야 합니다.

예를 들어

/*!
    ...
    \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.
*/

State 유형에 대한 참조 페이지에서 QDoc이 이 속성을 렌더링하는 방법을 참조하세요.

\qmlenumeratorsfrom

속성 유형 열거가 있는 토픽에서 \qmlenumeratorsfrom 명령을 사용하면 \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에 도입되었습니다.

또한 \qmlproperty, \enum및 \value.

\dontdocument

\dontdocument 명령은 특정 모듈의 dontdocument.qdoc 파일에서만 사용됩니다. 이 파일은 문서화할 필요가 없는 공개적으로 선언된 클래스나 구조체를 지정합니다. QDoc은 이러한 클래스 및 구조체에 대한 \class 주석 누락에 대한 경고를 출력하지 않습니다.

아래는 위젯에 대한 dontdocument.qdoc의 \dontdocument 명령어입니다:

/*!
   \dontdocument (QTypeInfo QMetaTypeId)
*/

\inheaderfile

\inheaderfile 메타 명령은 C++ 클래스, 네임스페이스 또는 헤더 파일 참조 문서에 대해 생성된 include 문을 재정의하는 데 사용됩니다.

기본적으로 QDoc은 \class SomeClass 을 다음 include 문과 함께 사용할 수 있도록 문서화합니다:

#include <SomeClass>

실제 include 문이 기본값과 다른 경우 다음과 같이 문서화할 수 있습니다.

\class SomeClass
\inheaderfile Tools/SomeClass
...

또한 \class 와 \headerfile.

\obsolete

\obsolete 명령은 \deprecated 명령으로 대체됩니다.

이 명령은 이전 버전과의 호환성을 위해서만 유지됩니다. 이 명령은 향후 버전의 QDoc에서 제거될 수 있습니다. 대신 \deprecated 명령을 사용하세요.

참조 \deprecated.

\deprecated

\deprecated 명령은 관련 요소가 더 이상 사용되지 않으며 새 코드에서 더 이상 사용하지 말아야 함을 나타내는 데 사용됩니다.

\deprecated 명령은 두 개의 선택적 인수를 받습니다:

• 대괄호 안의 버전(예: [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;
}

이 함수는 -showinternal 명령줄 옵션으로 QDoc을 호출하거나 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 명령은 QML 속성을 읽기 전용으로 표시하기 위해 \qmlproperty 명령과 함께 사용하여 QML 속성을 읽기 전용으로 표시합니다.

\required

\required 명령은 QML 속성을 필요한 경우 \qmlproperty 명령과 함께 사용하여 QML 속성을 필요에 따라 표시합니다.

속성 시스템도참조하세요.

\since

\since 명령은 관련 기능이 추가된 마이너 릴리스를 알려줍니다.

\since 에 전달된 인수에 공백이 없으면 제품 이름의 축약 표기법으로 간주되며, QDoc은 생성된 출력에서 productname 값으로 버전 앞에 접두사를 붙입니다. productname 변수가 정의되지 않은 경우 QDoc은 버전 문자열만 생성합니다.

인수는 제품 이름을 명시적으로 포함할 수도 있습니다:

\since MyFramework 2.0

이 경우 인수(제품 및 버전)가 그대로 사용됩니다.

이후 정보 상속

QDoc 버전 6.5부터 C++ 클래스와 QML 유형은 \since 이 유형 문서에 명시적으로 사용되지 않는 한 해당 모듈 또는 QML 모듈에서 \since 문을 상속합니다.

Since 절

\value 명령은 대괄호로 묶인 이후 절(선택 사항)을 명령 문자열 바로 뒤에 사용할 수 있습니다. 이는 특정 C++ 열거형 값을 이후 정보로 표시하는 데 사용됩니다.

또한 \value 및 무시하기.

\wrapper

\wrapper 명령은 C++ 클래스 문서에서 사용될 때 클래스를 Qt 이외의 API에 대한 액세스를 제공하는 래퍼로 표시합니다. 이 명령은 해당 클래스의 멤버에 대해 생성될 수 있는 경고를 억제하는 데 사용됩니다.