이 명령은 문서의 시각적 모양 및 문서 생성 프로세스와 관련된 기타 기능을 제공합니다.

\주석 목록

annotatedlist 명령은 그룹의 구성원 목록으로 확장되며, 각 구성원은 간단한 텍스트와 함께 나열됩니다. 아래는 Qt 참조 문서의 예제입니다:

/*!
   ...
   \section1 Drag and Drop Classes

   These classes deal with drag and drop and the necessary mime type
   encoding and decoding.

   \annotatedlist draganddrop
*/

이 명령은 드래그앤드롭 그룹에 있는 모든 C++ 클래스 및/또는 QML 유형 목록을 생성합니다. 드래그앤드롭 그룹의 C++ 클래스 또는 QML 유형은 그 \class 또는 \qmltype 주석에 \ingroup draganddrop이 포함됩니다.

그룹 멤버는 사용자가 볼 수 있는 이름 또는 제목을 기준으로 오름차순으로 정렬됩니다. QDoc 6.8부터 \주석 목록 및 \generatelist 는 사용자 지정 정렬도 지원합니다.

또한 \generatelist 및 그룹 구성원 정렬하기를 참조하세요.

\qtcmakepackage

qtcmakepackage 명령을 사용하여 클래스 및 네임스페이스에 CMake 패키지 정보를 추가합니다. 그러면 이 정보가 클래스 또는 네임스페이스 문서 페이지 상단의 표에 표시됩니다. 예를 들어

/*!
    \namespace Foo
    \inheaderfile Bar
    \qtcmakepackage Baz
    \brief A namespace.

    ...
*/

QDoc은 다음과 같이 출력합니다.

Foo 네임스페이스

네임스페이스입니다. 더 보기...

헤더:	#include <Bar>
CMake:	find_package(Qt6 필수 컴포넌트 바즈)

\qtcmaketargetitem

클래스 및 네임스페이스에 추가되는 CMake target_link_libraries 정보의 항목 부분을 재정의하려면 \qtcmaketargetitem 명령을 사용합니다. 이 명령은 \module 및 \qtcmakepackage} 명령과 함께 사용해야 합니다.

모듈 및 \qtcmakepackage}도참조하십시오.

\생성 목록

generatelist 명령은 아래 나열된 인수 중 하나와 일치하는 엔티티 또는 \ingroup 명령으로 그룹화된 문서 엔티티에 대한 링크 목록으로 확장됩니다. Qt 참조 문서의 예제입니다:

/*!
   \page classes.html
   \title All Classes

   For a shorter list that only includes the most
   frequently used classes, see \l{Qt's Main Classes}.

   \generatelist classes Q
*/

이 명령은 모든 클래스 페이지를 생성합니다. 이 명령은 다음과 같은 인수를 사용할 수 있습니다:

<group-name>

그룹 이름을 유일한 인수로 사용하면 QDoc은 \ingroup <group-name> 명령을 사용하는 모든 엔터티를 나열합니다.

그룹 구성원 정렬하기

그룹 구성원 목록을 생성할 때 사용자에게 표시되는 이름 또는 제목을 기준으로 오름차순으로 정렬됩니다. QDoc 6.8부터는 기본 정렬 순서를 수정할 수 있습니다:

\generatelist [descending] changelogs

변경 로그 그룹이 여러 버전의 변경 내용을 자세히 설명하는 페이지로 구성되어 있다고 가정하면 내림차순(최신 버전 먼저)으로 목록이 생성됩니다.

정렬 키

QDoc 6.8부터 사용자 지정 정렬 키를 하나 이상의 그룹 멤버에 할당할 수 있습니다. \meta 명령을 사용하여 하나 이상의 그룹 멤버에 사용자 지정 정렬 키를 지정할 수 있습니다:

\meta sortkey {sort key}

그러면 사용자에게 표시되는 제목이 아닌 이 키를 기준으로 정렬(오름차순 또는 내림차순)이 수행됩니다.

annotatedclasses

annotatedclasses 인수는 모든 클래스의 이름과 각 클래스에 대한 설명이 포함된 테이블을 제공합니다. 각 클래스 이름은 해당 클래스의 참조 문서에 대한 링크입니다. 예를 들어

C++ 클래스는 \class 명령으로 문서화됩니다. 클래스에 대한 주석은 클래스 주석의 \brief 명령의 인수에서 가져옵니다.

annotatedexamples

annotatedexamples 인수는 모든 예제의 제목과 각 예제에 대한 설명이 포함된 표 집합으로 모든 예제의 전체 목록을 제공합니다. 각 제목은 예제 문서로 연결되는 링크입니다.

각 모듈(예제가 문서화되어 있는)에 대해 별도의 테이블이 생성되며, 모듈에 navigation.landingpage 구성 변수가 정의되어 있는 경우에만 생성됩니다. 랜딩페이지 변수는 각 테이블 앞에 오는 헤더의 제목으로 사용됩니다.

annotatedattributions

annotatedattributions 인수는 모든 속성의 제목과 각 속성에 대한 설명이 포함된 테이블 집합으로 모든 속성의 전체 목록을 제공합니다. 각 제목은 해당 속성 페이지로 연결되는 링크입니다.

각 모듈(어트리뷰션이 있는)에 대한 별도의 테이블이 생성되며, 모듈에 navigation.landingpage 구성 변수가 정의되어 있는 경우 이 테이블이 생성됩니다. 랜딩페이지 변수는 각 테이블 앞에 오는 헤더의 제목으로 사용됩니다.

classes <prefix>

classes 인수는 클래스의 전체 알파벳순 목록을 제공합니다. 두 번째 인수인 <prefix> 는 클래스 이름의 공통 접두사입니다. 클래스 이름은 공통 접두사 뒤에 오는 문자를 기준으로 정렬됩니다. 예를 들어, Qt 클래스의 공통 접두사는 Q 입니다. 공통 접두사 인수는 선택 사항입니다. 공통 접두사를 제공하지 않으면 클래스 이름은 첫 번째 문자를 기준으로 정렬됩니다.

각 클래스 이름은 클래스의 참조 문서에 대한 링크가 됩니다. 이 명령은 이러한 방식으로 모든 클래스 페이지를 생성하는 데 사용됩니다:

/*!
    \page classes.html
    \title All Classes
    \ingroup classlists

    \brief Alphabetical list of classes.

    This is a list of all Qt classes. For classes that
    have been deprecated, see the \l{Obsolete Classes}
    list.

    \generatelist classes Q
*/

C++ 클래스는 \class 명령으로 문서화됩니다.

classesbymodule

이 인수를 사용할 때는 클래스를 나열할 모듈을 지정하는 두 번째 인수가 필요합니다. QDoc은 해당 클래스가 포함된 테이블을 생성합니다. 각 클래스는 해당 \brief 명령의 텍스트와 함께 나열됩니다.

예를 들어 이 명령은 모듈 페이지에서 다음과 같이 사용할 수 있습니다:

/*!
    \page phonon-module.html
    \module Phonon
    \title Phonon Module
    \ingroup modules

    \brief Contains namespaces and classes for multimedia functionality.

    \generatelist{classesbymodule Phonon}

    ...
*/

지정된 모듈의 멤버인 각 클래스는 해당 \class 주석에 \inmodule 명령으로 표시해야 합니다.

qmltypesbymodule

classesbymodule 인자와 유사하지만 두 번째 인수로 지정된 QML 모듈의 QML 유형(QML 값 유형 제외)을 나열하는 데 사용됩니다.

qmlvaluetypesbymodule

qmltypesbymodule 인자와 유사하지만 대신 QML 값 유형을 나열합니다.

functionindex

functionindex 인수는 문서화된 모든 멤버 함수의 전체 알파벳순 목록을 제공합니다. 이 인수는 일반적으로 이런 방식으로 Qt 함수 색인 페이지를 생성할 때만 사용됩니다:

/*!
    \page functions.html
    \title All Functions
    \ingroup funclists

    \brief All documented Qt functions listed alphabetically with a
    link to where each one is declared.

    This is the list of all documented member functions and global
    functions in the Qt API. Each function has a link to the
    class or header file where it is declared and documented.

    \generatelist functionindex
*/

legalese

legalese 인수는 현재 문서화 프로젝트에 있는 라이선스 목록을 생성하도록 QDoc에 지시합니다. 각 라이선스는 \legalese 명령을 사용하여 식별됩니다.

overviews

overviews 인수는 모든 \group 페이지의 내용을 연결하여 목록을 생성하도록 QDoc에 지시하는 데 사용됩니다. Qt는 이 인수를 사용하여 이러한 방식으로 개요 페이지를 생성합니다:

/*!
    \page overviews.html

    \title All Overviews and HOWTOs

    \generatelist overviews
*/

attributions

attributions 인수는 문서에서 어트리뷰션 목록을 생성하도록 QDoc에 지시하는 데 사용됩니다.

related

related 인수는 지정된 그룹과 관련된 모든 개요를 나열하기 위해 \group 및 \ingroup 명령과 함께 사용됩니다. 예를 들어, Qt로 프로그래밍 페이지의 페이지는 이러한 방식으로 생성됩니다:

/*!
    \group qt-basic-concepts
    \title Programming with Qt

    \brief The basic architecture of the Qt cross-platform application and UI framework.

    Qt is a cross-platform application and UI framework for
    writing web-enabled applications for desktop, mobile, and
    embedded operating systems. This page contains links to
    articles and overviews explaining key components and
    techniuqes used in Qt development.

    \generatelist {related}
*/

이 그룹 페이지에 나열된 각 페이지에는 명령이 포함되어 있습니다:

\ingroup qt-basic-concepts

또한 \annotatedlist.

\if

if 명령과 그에 해당하는 \endif 명령은 명령의 인수로 지정된 조건이 참인 경우에만 포함되는 QDoc 주석의 일부를 묶습니다.

이 명령은 나머지 줄을 읽고 C++ #if 문으로 구문 분석합니다.

/*!
   \if defined(opensourceedition)

   \note This edition is for the development of
   \l{Qt Open Source Edition} {Free and Open Source}
   software only; see \l{Qt Commercial Editions}.

   \endif
*/

이 QDoc 주석은 opensourceedition 전처리기 기호가 정의된 경우에만 렌더링되며, 구성 파일의 defines 변수에 지정하여 #ifdef 및 #endif 내의 코드를 QDoc이 처리하도록 합니다:

defines = opensourceedition

명령줄에서 전처리기 기호를 수동으로 정의할 수도 있습니다. 자세한 내용은 defines 변수 설명서를 참조하세요.

endif, \else, defines 및 거짓도 참조하세요.

\endif

endif 명령과 그에 해당하는 \if 명령은 \if 명령의 인수로 지정된 조건이 참일 경우 포함될 QDoc 주석의 일부를 묶습니다.

자세한 내용은 \if 명령의 설명서를 참조하세요.

또한 \if, \else, 정의 및 거짓을 참조하세요.

\else

else 명령은 \if 명령의 조건이 거짓인 경우 대안을 지정합니다.

else 명령은 \if...\endif 명령 내에서만 사용할 수 있지만 대안이 두 개만 있을 때 유용합니다.

\포함

include 명령은 첫 번째 인수로 지정된 파일의 전체 또는 일부를 QDoc 입력 스트림으로 전송하여 QDoc 주석 스니펫으로 처리합니다.

이 명령은 명령이나 텍스트의 일부 스니펫을 문서의 여러 위치에서 사용해야 할 때 유용합니다. 문서에 스니펫을 삽입하려는 위치에 \include 명령을 사용합니다. 포함할 스니펫이 포함된 파일은 sourcedirs 또는 exampledirs QDoc 구성 변수에 나열된 경로 아래에 있어야 합니다. QDoc에서 파싱한 소스 파일(또는 \include 명령이 사용된 동일한 파일) 또는 기타 텍스트 파일일 수 있습니다. QDoc에서 구문 분석하지 않는 별도의 파일에 코드 조각을 저장하려면 sources.fileextensions에 나열되지 않은 파일 확장자(예: .qdocinc)를 사용합니다.

이 명령은 하나 이상의 인수를 가질 수 있습니다. 첫 번째 인수는 항상 파일 이름입니다. 파일의 내용은 QDoc 입력, 즉 QDoc 명령과 텍스트의 시퀀스여야 하지만 묶는 QDoc 주석 /*! ... */ 구분 기호는 없어야 합니다. 명명된 파일 전체를 포함하려면 두 번째 인수를 비워 둡니다. 파일의 일부만 포함하려면 아래의 두 가지 인수 형식을 참조하세요. 다음은 하나의 인자 형식의 예입니다:

/*!
    \page corefeatures.html
    \title Core Features

    \include examples/signalandslots.qdocinc
    \include examples/objectmodel.qdocinc
    \include examples/layoutmanagement.qdocinc
*/

\파일명 스니펫 식별자 포함

문서의 여러 위치에 사용하려는 모든 QDoc 포함 스니펫에 대해 별도의 .qdocinc 파일을 만드는 것은 시간 낭비이며, 특히 이러한 모든 파일에 저작권/라이선스 고지를 넣어야 한다는 점을 고려할 때 더욱 그렇습니다. 포함할 스니펫이 여러 개 있는 경우 하나의 파일에 모두 넣고 각 파일을 둘러싸면 됩니다:

//! [snippet-id1]

QDoc commands and text...

//! [snippet-id1]

//! [snippet-id2]

More QDoc commands and text...

//! [snippet-id2]

그런 다음 두 개의 인수로 구성된 명령 형태를 사용할 수 있습니다:

\include examples/signalandslots.qdocinc snippet-id2
\include examples/objectmodel.qdocinc another-snippet-id

두 번째 인수와 이름이 같은 두 태그 사이에 있는 QDoc 명령과 텍스트의 순서가 QDoc 입력 스트림으로 전송됩니다. 중첩된 스니펫을 가질 수도 있습니다.

추가 인수

QDoc 6.3부터 \include 명령에 전달된 모든 추가 인수는 포함된 콘텐츠에 문자열을 삽입하는 데 사용됩니다. 콘텐츠의 특정 위치에 문자열을 삽입하려면 백슬래시 뒤에 숫자(1..9)를 추가합니다. 숫자는 인수 목록의 순서와 일치합니다. 인수를 중괄호로 묶어 QDoc이 예상대로 공백 문자를 포함한 전체 인수를 렌더링하도록 합니다.

예를 들어 파일에 다음 스니펫이 있다고 가정할 때 includes.qdocinc:

//! [usage]
To enable \e{\1}, select \uicontrol {\2} > \uicontrol Enable.
//! [usage]

그런 다음 다음 \include 줄을 추가합니다:

\include includes.qdocinc {usage} {detailed output} {Verbose}

렌더링

자세한 출력을 활성화하려면 Verbose > Enable 을 선택합니다.

\메타

meta 명령은 문서에 메타데이터를 추가하는 데 사용됩니다. 이 명령에는 두 개의 인수가 있습니다. 첫 번째 인수는 메타데이터 속성의 이름이고 두 번째 인수는 속성 값입니다. 이 예에서와 같이 각 인수는 중괄호로 묶어야 합니다:

/*!
    \example demos/coffee
    \title Coffee Machine
    \brief A Qt Quick application with a state-based custom user interface.

    \meta {tags} {quick,embedded,states,touch}
    \meta {category} {Application Examples}
*/

여러 메타데이터 속성에는 특정 목적이 있습니다:

메타데이터 예시

메타 명령의 또 다른 용도는 \example 문서에 메타데이터(태그)를 포함하는 것입니다. 기본적으로 QDoc은 예제의 \title 및 모듈 이름을 기반으로 예제 태그를 생성합니다. 이러한 태그는 Qt Creator 의 시작 모드에 표시되어 사용자가 예제 목록을 탐색하는 데 도움이 됩니다.

\meta {tag} {tag1} 또는 \meta {tags} {tag1,[tag2,...]} 을 사용하여 추가 태그를 만들 수 있습니다. 예를 들어

/*!
    \example helloworld
    \title Hello World Example
    \meta {tags} {tutorial,basic}
*/

이 경우 튜토리얼, 기본, 안녕하세요, 세계 등의 태그가 생성됩니다. example와 같은 일반적인 단어는 무시됩니다.

예제 제외

예제를 깨진 것으로 표시하면 생성된 매니페스트 파일에서 제외되어 Qt Creator 의 웰컴 모드에서 효과적으로 제거됩니다.

\meta {tag} {broken}

예제 설치 경로

meta 명령과 installpath 인수를 함께 사용하면 설치된 예제의 위치를 지정합니다. 이 값은 examplesinstallpath 구성 변수를 사용하여 설정된 값을 재정의합니다.

/*!
    \example helloworld
    \title Hello World Example
    \meta {installpath} {tutorials}
*/

examplesinstallpath도 참조하세요.

Status

meta 명령의 status 인수는 \class 또는 \qmltype에 대한 사용자 지정 상태 설명을 추가합니다. 그러면 이 설명이 유형 참조 페이지 상단의 표에 표시됩니다.

/*!
    \class QNativeInterface::QAndroidApplication
    \meta {status} {Android-specific}
*/

상태 관련 명령도 참조하세요.

\noautolist

noautolist 명령은 클래스 또는 유형이 수동으로 나열되었으므로 C++ 또는 QML 모듈 페이지 하단에 자동으로 생성되는 C++ 클래스 또는 QML 유형의 주석이 달린 목록을 생략해야 함을 나타냅니다. 이 명령은 그룹 멤버가 수동으로 나열된 경우 \group 명령과 함께 사용하여 그룹 멤버 목록을 생략할 수도 있습니다.

이 명령은 자체 줄에 서야 합니다. 예는 Qt Quick Controls QML Types 를 참조하세요. 이 페이지는 qtquickcontrols2-qmlmodule.qdoc 에서 생성됩니다. 여기에는 QtQuick.Controls 모듈에 대한 \qmlmodule 명령이 포함된 QDoc 댓글이 있습니다. 같은 주석에는 자동 목록 생성을 비활성화하는 \noautolist 명령과 문서의 특정 섹션에 QML 유형을 나열하는 \generatelist가 포함되어 있습니다.

이 명령은 QDoc 5.6에 도입되었습니다.

Qt 5.10부터 이 명령은 예제 프로젝트에 속하는 파일과 이미지의 자동 생성 목록을 생략하는 \example documentation에도 적용할 수 있습니다.

\omit

omit 명령과 그에 대응하는 \endomit 명령은 QDoc에서 건너뛰고 싶은 문서 부분을 구분합니다. 예를 들어

/*!
    \table
    \row
        \li Basic Widgets
        \li Basic GUI widgets such as buttons, comboboxes
           and scrollbars.

    \omit
    \row
        \li Component Model
        \li Interfaces and helper classes for the Qt
           Component Model.
    \endomit

    \row
        \li Database Classes
        \li Database related classes, e.g. for SQL databases.
    \endtable
*/

\raw(피하기!)

draw 명령과 그에 해당하는 \endraw 명령은 원시 마크업 언어 코드 블록을 구분합니다.

이 명령은 코드 형식을 지정하는 인수를 받습니다.

QDoc은 사용자가 지정한 형식을 생성할 때만 지정된 코드를 생성합니다.

예를 들어, "\raw HTML"은 QDoc이 HTML 문서를 생성할 때만 코드를 생성합니다.

\sincelist

sincelist 명령은 지정된 버전의 문서화된 API에 새로 추가된 항목에 대한 자세한 분석으로 확장됩니다. 사용 예

/*!
   \page newclasses68.html
   \title New Classes and Functions in 6.8
   \brief A comprehensive list of new classes and functions in 6.8.

   \sincelist 6.8
*/

\sincelist는 단일 인수인 버전 문자열을 받습니다. 생성된 출력에는 버전 문자열과 일치하는 \since 명령 또는 이후 절로 표시된 모든 기능이 포함됩니다.

\유니코드

유니코드 명령을 사용하면 문서에 임의의 유니코드 문자를 삽입할 수 있습니다.

이 명령은 문자를 정수로 지정하는 인수를 받습니다. 기본적으로 '0x' 또는 '0' 접두사가 지정되지 않는 한 기본값 10이 사용됩니다(각각 기본값 16 및 8의 경우).