QDoc 구성 파일

QDoc을 실행하기 전에 QDoc 주석을 포함하는 소스 파일을 찾을 수 있는 위치를 QDoc에 알려주는 QDoc 구성 파일을 만들어야 합니다. 구성 파일의 경로명은 명령줄에서 QDoc에 전달됩니다:

/current/dir$ ../../bin/qdoc ./config.qdocconf

일반 설명

구성 파일은 "변수 = 값" 형식의 항목 목록입니다. 구성 변수를 사용하여 QDoc이 다양한 소스 파일, 이미지 및 예제를 찾을 위치, 생성된 문서를 넣을 위치 등을 정의할 수 있습니다. 구성 파일에는 include 와 같은 지시문을 포함할 수도 있습니다. 예는 minimum.qdocconf를 참조하세요.

또한 구성 변수를 사용하여 QDoc이 파생 프로젝트를 지원하도록 할 수 있습니다. 즉, QDoc은 프로젝트 문서에서 Qt 온라인 문서의 요소에 대한 링크를 생성할 수 있습니다. 파생 프로젝트 지원 섹션을 참조하십시오.

유효한 구성 변수 이름에는 대문자 및 소문자, 숫자, 밑줄 '_'가 포함될 수 있습니다.

구성 변수의 값은 '=' 또는 '+='를 사용하여 설정할 수 있습니다. '='는 이전 값을 재정의하는 반면 '+='는 현재 값에 새 값을 추가한다는 차이점이 있습니다.

일부 설정 변수의 값은 예를 들어 문자열 목록으로 해석됩니다: sourcedirs와 같은 문자열 목록으로 해석되는 반면, 다른 변수는 단일 문자열로 취급됩니다. 값 문자열 주위의 큰따옴표는 선택 사항이지만, 큰따옴표를 포함하면 '=' 및 ' " ' 같은 특수 문자를 값 문자열에 사용할 수 있습니다. ' 등의 특수 문자를 사용할 수 있습니다:

HTML.postheader = "<a href=\"index.html\">Home</a>"

항목이 여러 줄에 걸쳐 있는 경우 마지막 줄을 제외한 모든 줄의 끝에 백슬래시를 사용합니다:

sourcedirs = kernel tools widgets

다음과 같이 작성할 수 있습니다:

sourcedirs = kernel \
             tools \
             widgets

값이 여러 줄에 걸쳐 있지만 단일 문자열로 해석되는 경우 줄은 공백으로 연결됩니다.

구성 값 확장

QDoc은 구성 파일 내에서 환경 변수 확장을 지원합니다. 예를 들어, Qt 모듈은 모든 Qt 모듈 문서화 프로젝트와 관련된 정의를 포함하기 위해 환경 변수 QT_INSTALL_DOCS에 의존합니다:

include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)

확장할 변수 앞에는 '$'가 붙습니다. 값 문자열 내에서 리터럴 문자 '$'를 사용하려면 백슬래시 '\$'로 이스케이프 처리합니다.

QDoc 6.0부터는 다른 구성 변수에서도 값을 확장할 수 있습니다. $variable 구문 외에도 ${variable} 구문도 유효합니다. 후자를 사용하면 변수 이름을 공백이나 변수가 아닌 문자로 구분할 필요가 없습니다. 예를 들어

baseurl = https://doc.qt.io/
...
url = ${baseurl}qtcreator

대상 변수가 문자열 목록을 참조하는 경우 확장된 값에 공백을 사용하여 조인됩니다:

vars = foo \
       bar \
       baz

items = "Items: $vars"          # Expands to "Items: foo bar baz"

문자열 목록을 조인하는 데 사용되는 문자를 제어할 수도 있습니다:

items = "Items: ${vars,|}"      # Expands to "Items: foo|bar|baz"
items = "Items: ${vars,,}"      # Expands to "Items: foo,bar,baz"
items = "Items: ${vars,}"       # Expands to "Items: foobarbaz"

모든 변수를 읽은 후 확장이 수행되므로 변수가 정의된 순서는 중요하지 않습니다.

환경 변수 확장하기

환경 변수를 확장할 때 ${variable} 구문은 $variable 구문과 다른 동작을 합니다. 전자는 구성 파일의 일부로 파싱할 변수의 내용을 확장하는 반면, 후자는 단순히 현재 구성 변수의 값으로 내용을 할당합니다. 이는 환경 변수에 공백으로 구분된 요소 목록이나 QDoc에서 인식하는 기타 서식이 포함된 경우에 영향을 미칩니다.

예를 들어 환경 변수 SRCDIRS 의 값이 "../src/a ../src/b" 인 경우 다음과 같습니다.

sourcedirs  = $SRCDIRS      # Fail - value is interpreted as a single path.
sourcedirs  = ${SRCDIRS}    # Ok - whitespace is used as a delimiter.

환경 변수

변수 목록

• 정의
• 의존하는
• 예제
• 예제
• 예제 설치 경로
• examples.fileextensions
• excludedirs
• 제외 파일
• extraimages
• 거짓
• headerdirs
• headers
• headers.fileextensions
• HTML.footer
• HTML.postheader
• HTML.style
• 포함 경로
• 무시 단어
• 무시
• 이미지
• 인덱스
• 언어
• 위치정보
• macro
• 매니페스트메타
• 모듈헤더
• navigation
• outputdir
• 출력 형식
• 출력 접두사
• 출력 접미사
• 프로젝트
• sourcedirs
• sources
• sources.파일 확장자
• spurious
• 탭 크기
• url
• url.examples
• version
• versionsym
• 경고 제한

카테고리

• 일반 구성 변수
• 형식별 구성 변수

구성 파일 예제

• 최소 구성 파일: minimum.qdocconf
• Qt 구성 파일: qtgui.qdocconf