사물 그룹화

그룹화 명령은 클래스를 정의된 그룹과 모듈에 연관시킵니다. 그룹은 문서에서 관련 클래스의 목록을 생성할 때 사용되며, 모듈은 Qt 구조의 요소입니다.

명령

\ingroup

그룹 명령은 지정된 클래스, 페이지 또는 기타 엔티티가 관련 문서의 특정 그룹에 속해 있음을 나타냅니다.

엔티티는 여러 그룹에 속할 수 있습니다.

그룹 명령의 인수는 그룹 이름이지만 명령은 줄의 나머지 부분을 인수의 일부로 간주합니다. 그룹 이름 뒤에 줄 바꿈이 와야 합니다.

/*!
    \class QDir
    \brief The QDir class provides access to directory
           structures and their contents.

    \ingroup io
    ...
*/

이렇게 하면 io 그룹에 QDir 클래스가 추가됩니다. 그러면 예를 들어 인수가 io 인 \annotatedlist 명령으로 만든 목록에 QDir 항목이 나타납니다.

QDoc은 C++ 클래스, 네임스페이스 또는 헤더 참조 페이지에 연결된 그룹에 대한 링크를 자동으로 생성합니다. 예를 들어, 위의 QDir 클래스에 대한 문서와 다음 \group 페이지가 있다고 가정해 보겠습니다:

/*
    \group io
    \title Input/Output and Networking
    ...
*/

그러면 QDoc은 QDir 참조 페이지에 문을 출력합니다:

• QDir은 입력/출력 및 네트워킹의 일부입니다.

HTML 출력의 경우, QDoc은 탐색 모음(이동 경로)의 일부로 그룹 페이지에 대한 링크도 생성합니다. 여러 \ingroup 명령이 사용되는 경우 문서화된 \group을 참조하는 첫 번째 명령이 선택됩니다.

그룹도 참조하세요.

\inmodule

inmodule 명령은 클래스를 명령의 인수로 지정된 모듈에 연결합니다.

Qt의 기본 클래스의 경우, 클래스의 모듈은 그 위치, 즉 디렉터리에 의해 결정됩니다. 그러나 ActiveQt 및 Qt Widgets Designer 와 같은 확장의 경우 클래스는 모듈과 명시적으로 연관되어야 합니다.

명령의 인수는 모듈 이름이지만 명령은 줄의 나머지 부분을 인수의 일부로 간주합니다. 모듈 이름 뒤에 줄 바꿈이 오는지 확인하세요.

/*!
    \class QDesignerTaskMenuExtension
    \inmodule QtDesigner
* /

이렇게 하면 QDesignerTaskMenuExtension 클래스가 Qt Widgets Designer 모듈에 포함되므로 예를 들어 {classesbymodule QtDesigner} 인수를 사용하여 \generatelist 명령을 호출하여 만든 목록에 해당 클래스가 표시됩니다.

module 및 \generatelist도 참조하세요.