QDoc 구성 파일

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

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

일반 설명

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

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

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

구성 변수의 값은 '=' 또는 '+='를 사용하여 설정할 수 있습니다. 두 기호의 차이점은 '='는 이전 값을 덮어쓰는 반면, '+='는 현재 값에 새로운 값을 추가한다는 점입니다.

일부 구성 변수의 값은 문자열 목록으로 해석됩니다. 예를 들어: sourcedirs, 반면 다른 변수들은 단일 문자열로 처리됩니다. 값 문자열을 큰따옴표로 묶는 것은 선택 사항이지만, 큰따옴표를 사용하면 값 문자열 내에서 '='나 ' " '와 같은 특수 문자를 사용할 수 있습니다. 예를 들어:

HTML.postheader = "<ul class=\"breadcrumbs\">"

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

sourcedirs = kernel tools widgets

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

sourcedirs = kernel \
             tools \
             widgets

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

구성 값의 확장

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

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
• 예제.이미지 누락 경고
• examples.warnaboutmissingprojectfiles
• 제외된 디렉터리
• 제외할 파일
• 추가 이미지
• 허위 정보
• 헤더 디렉터리
• 헤더
• 헤더 파일 확장자
• HTML.footer
• HTML.postheader
• HTML.postpostheader
• HTML.style
• 포함 경로
• includeprivate
• ignorewords
• ignoresince
• 이미지 디렉터리
• 이미지 출력 디렉터리
• 인덱스
• 언어
• 위치 정보
• logwarnings
• 매크로
• 매니페스트 메타
• 모듈 헤더
• navigation
• outputdir
• 출력 형식
• 출력 접두사
• 출력 접미사
• parsecpp 주석
• preliminary
• 제품명
• project
• projectroot
• 자동 생성된 문서 표시
• 소스 디렉토리
• 소스
• 소스 파일 확장자
• spurious
• 탭 크기
• url
• url.examples
• url.sources
• 대체 텍스트를 제목으로 사용
• 버전
• 버전 심볼
• 경고 제한

카테고리

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

구성 파일 예시

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