사물 묶기

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

명령어

\ingroup

\ingroup 명령어는 지정된 클래스, 페이지 또는 기타 개체가 특정 관련 문서 그룹에 속함을 나타냅니다.

한 개체는 여러 그룹에 속할 수 있습니다.

\ingroup 명령어의 인수는 그룹 이름이지만, 이 명령어는 해당 줄의 나머지 부분을 인수의 일부로 간주한다는 점에 유의하십시오. 그룹 이름 뒤에는 반드시 줄 바꿈을 넣어야 합니다.

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

    \ingroup io
    ...
*/

QDir 이렇게 하면 QDir 클래스가 io 그룹에 추가됩니다. 그러면 예를 들어 \annotatedlist 명령어에 인자로 ` io`를 지정하여 생성된 목록에 ` ` 항목이 표시됩니다.

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

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

QDoc은 QDir 참조 페이지에 다음과 같은 문장을 출력합니다:

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

HTML 출력의 경우, QDoc은 탐색 모음(브레드크럼)의 일부로 해당 그룹 페이지로 연결되는 링크도 생성합니다. 여러 개의 \ingroup 명령이 사용된 경우, 문서화된 \group 를 참조하는 첫 번째 명령이 선택됩니다.

참조 \group.

\inmodule

\inmodule 명령어는 클래스를 해당 명령어의 인자로 지정된 모듈과 연관시킵니다.

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

이 명령어의 인수는 모듈 이름이지만, 명령어는 해당 줄의 나머지 부분을 인수의 일부로 간주한다는 점에 유의하십시오. 모듈 이름 뒤에는 반드시 줄바꿈을 넣어야 합니다.

/*!
    \class QDesignerTaskMenuExtension
    \inmodule QtDesigner
* /

이렇게 하면 QDesignerTaskMenuExtension 클래스가 Qt Widgets Designer 모듈에 포함되도록 보장되며, 이는 예를 들어 인수를 사용하여 \generatelist 명령어를 호출할 때 ` {classesbymodule QtDesigner} ` 인수를 지정하면 생성된 목록에 해당 클래스가 표시된다는 뜻입니다.

참조: \module 및 \generatelist참조하십시오.