관련 사물

관련 명령은 문서화된 한 요소가 다른 문서화된 요소와 어떻게 관련되는지 지정하는 데 사용됩니다. 몇 가지 예가 있습니다:

• 이 함수는 다른 함수의 오버로드입니다.
• 이 함수는 다른 함수의 재구현입니다.
• 이 typedef는 일부 클래스 또는 헤더 파일과 관련이 있습니다.

QML 유형이 다른 QML 유형을 상속한다는 것을 문서화하기 위한 명령도 있습니다.

명령

\inherits

\inherits 명령은 한 QML 유형이 다른 QML 유형을 상속한다는 것을 문서화하기 위한 명령입니다. 이 명령은 상속하는 요소의 \qmltype 주석에 포함되어야 합니다. 인수는 상속된 QML 유형의 이름이며, 선택적으로 QML 모듈 이름으로 한정할 수 있습니다.

/*!
    \qmltype PauseAnimation
    \inqmlmodule QtQuick
    \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 요소에 대한 참조 페이지에 이 줄을 포함합니다:

Inherits Animation

.qml 파일에 직접 QML 유형을 문서화할 때는 일반적으로 QDoc이 QML 구문에서 기본 유형을 감지할 수 있으므로 \inherits 명령이 필요하지 않습니다. 있는 경우 \inherits 명령이 이 자동 기본 유형 감지를 재정의합니다.

\overload

C++ 함수 오버로드를 표시하려면 \overload 명령을 사용하여 C++ 함수 오버로드를 표시합니다. 이 명령은 문서 주석의 자체 줄에 표시되어야 합니다.

작동 방식

서로 다른 매개 변수로 유사한 작업을 수행하는 동일한 이름의 C++ 함수(오버로드)가 여러 개 있는 경우 반복되는 문서를 피하려면 \overload 를 사용하여 반복적인 문서 작성을 피하세요. 없는 함수는 \overload 함수는 완전한 문서가 필요합니다. 함수는 \overload 가 있는 함수는 특정 차이점에 집중할 수 있습니다.

로 표시된 함수는 \overload 로 표시된 함수는 기본 함수의 문서를 참조하므로 누락된 매개변수 경고가 자동으로 표시되지 않습니다.

기본 사용법

/*!
    \overload
    Brief description of what makes this overload different.
*/

기본 함수에 연결하기

함수 이름을 추가하여 기본 함수에 대한 링크를 만듭니다:

/*!
    \overload functionName()
    Brief description of what makes this overload different.
*/

정규화된 이름(ClassName::functionName()) 또는 정규화되지 않은 이름(functionName())을 사용합니다. QDoc은 현재 클래스 또는 네임스페이스를 사용하여 정규화되지 않은 이름을 자동으로 정규화합니다.

기본 오버로드 지정하기

기본적으로 QDoc은 기본 오버로드를 자동으로 선택합니다. 기본 오버로드를 명시적으로 지정하려면 다음을 사용합니다:

/*!
    \overload primary
    Main documentation for this function family.
    Document all parameters here.
*/

기본 과부하를 사용합니다:

• 주 함수 설명서를 포함합니다.
• 전체 매개변수 설명서가 필요합니다.
• "이 함수는 과부하가 걸립니다..." 텍스트를 표시하지 마세요.
• 다른 과부하에 대한 링크 대상으로 사용됩니다.

가장 중요한 오버로드가 QDoc의 자동 선택과 다르거나 일관된 연결 동작이 필요한 경우 \overload 기본값을 사용하세요.

\reimp

\reimp 명령은 추가 문서가 필요 없이 함수가 가상 함수의 재구현임을 나타내는 데 사용됩니다.

기본적으로 QDoc은 문서화되지 않는 한 클래스 참조에서 재구현된 가상 함수를 생략합니다. 이 명령을 사용하면 문서화되지 않은 함수가 포함될 수 있습니다.

이 명령은 자체 줄에 서야 합니다.

/*!
    \reimp
*/
void QToolButton::nextCheckState()
{
    Q_D(QToolButton);
    if (!d->defaultAction)
        QAbstractButton::nextCheckState();
    else
        d->defaultAction->trigger();
}

이 함수는 문서에 포함되지 않습니다. 대신 기본 함수 QAbstractButton::nextCheckState()에 대한 링크가 문서에 표시됩니다.

\relates

\relates 명령은 클래스, 네임스페이스 또는 헤더 파일에 엔티티(함수, 매크로, typedef, 열거형 또는 변수)의 문서를 포함시키는 데 사용됩니다. 인수는 엔티티와 관련된 클래스, 네임스페이스 또는 헤더의 이름입니다.

인수가 템플릿화된 유형을 참조하는 경우 템플릿 매개변수 없이 유형 이름만 사용합니다.

/*!
    \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 클래스에 대한 참조 페이지에 포함되어 있습니다.