QDoc 구성 파일 만들기

문서를 생성하기 위해 QDoc은 확장자가 qdocconf 인 구성 파일을 사용하여 구성 설정을 저장합니다.

다양한 구성 변수에 대한 자세한 내용은 QDoc 구성 파일 문서를 참조하세요.

QDoc 구성 파일

QDoc의 구성 설정은 하나의 qdocconf 파일에 있을 수 있지만 다른 qdocconf 파일에도 있을 수 있습니다. include(<filepath>) 명령을 사용하면 구성 파일에 다른 구성 파일을 포함할 수 있습니다.

QDoc에는 HTML 문서와 DocBook XML 형식의 문서라는 두 가지 출력이 있습니다. 두 출력의 주요 차이점은 HTML 문서는 구성 파일에 HTML 스타일링 정보가 있어야 한다는 것입니다. DocBook 문서는 그렇지 않으며, 나중에 별도의 프로세스를 통해 DocBook에서 문서에 스타일을 지정할 수 있습니다. 따라서 DocBook은 동일한 정보에 다른 스타일을 적용할 수 있는 유연성이 더 뛰어납니다.

QDoc을 실행하려면 프로젝트 구성 파일이 인수로 제공됩니다.

qdoc project.qdocconf

프로젝트 구성에는 QDoc이 문서를 만드는 데 사용하는 정보가 포함되어 있습니다.

프로젝트 정보

QDoc은 project 정보를 사용하여 문서를 생성합니다.

project = QDoc Project
description = Sample QDoc project

입력 및 출력 디렉토리

소스 디렉터리의 경로를 지정하면 QDoc이 소스를 찾아 문서를 생성할 수 있습니다.

sourcedirs = <path to source code>
exampledirs = <path to examples directory>
imagedirs = <path to image directory>

sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml"
examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng"

QDoc은 fileextensions 변수에 지정된 헤더와 소스에서 헤더와 소스를 처리합니다.

마찬가지로 QDoc에는 출력 디렉터리 경로가 필요합니다. outputformats 변수는 문서 유형을 결정합니다. 이러한 변수는 문서 빌드를 모듈화하기 위해 별도의 구성 파일에 있어야 합니다.

outputdir  =    $SAMPLE_PROJECT/doc/html
outputformats = HTML

QDoc은 환경 변수뿐만 아니라 qdocconf 파일을 기준으로 경로를 확인할 수 있습니다.

추가 파일

QDoc은 생성된 문서를 출력 디렉터리에 지정된 디렉터리로 출력합니다. QDoc이 내보내야 할 추가 파일을 지정할 수도 있습니다.

HTML.extraimages = extraImage.png \
                   extraImage2.png

extraImage.png 및 extraImage2.png 파일은 HTML 출력 디렉터리에 복사됩니다.

Qt Help 프레임워크 구성

QDoc은 Qt Help 프로젝트 파일도 qhp 파일로 내보냅니다. 그런 다음 qhelpgenerator 파일은 qch 파일에 문서를 패키징하는 데 사용됩니다. Qt Creator 및 Qt Assistant 은 qch 파일을 읽어 문서를 표시합니다.

도움말 프로젝트 파일 만들기 문서에서 구성 옵션에 대해 설명합니다.

HTML 구성

QDoc에는 다양한 구성 설정을 사용하여 일련의 문서를 HTML 파일로 내보내는 HTML 생성기가 있습니다. QDoc은 생성된 문서를 outputdir 변수로 지정된 디렉터리에 저장합니다.

outputformats = HTML
outputdir =  <path to output directory>

QDoc은 HTML을 생성하기 위한 스타일과 템플릿이 어디에 있는지 알아야 합니다. 일반적으로 템플릿 디렉터리에는 scripts, images, 그리고 스크립트 및 CSS 파일이 포함된 style 디렉터리가 있습니다.

주요 구성 변수는 다음과 같습니다:

HTML.postheader
HTML.postpostheader
HTML.postheader
HTML.footer

HTML.headerstyles
HTML.stylesheets = template/style/style.css \
                   template/style/style1.css

HTML.scripts = template/scripts/script.js

HTML.headerstyles 변수는 HTML 파일에 스타일 정보를 삽입하고 HTML.stylesheets 변수는 QDoc이 출력 디렉터리에 복사할 파일을 지정합니다. 또한 QDoc은 postheader, footer 및 관련 변수에 문자열을 각 HTML 파일에 삽입합니다.

형식별 구성 변수 문서에서 각 변수의 사용법을 간략하게 설명합니다.

QDoc 인덱스 파일

문서 프로젝트는 종속성 집합 또는 이 프로젝트가 의존하는 색인 파일의 직접 경로 집합을 지정하여 다른 프로젝트의 대상에 링크할 수 있습니다. QDoc이 프로젝트에 대한 문서를 생성할 때 프로젝트에서 링크 가능한 각 엔티티에 대한 URL이 포함된 .index 파일도 생성합니다. 그러면 다른 프로젝트에서 해당 프로젝트 내의 문서에 링크하기 위해 인덱스 파일에 대한 종속성을 정의할 수 있습니다.

종속 항목 및 인덱스도참조하세요.

매크로 및 기타 구성

HTML 문자를 대체하는 매크로가 존재하며 특정 HTML 유효 문자를 생성하는 데 유용합니다.

macro.pi.HTML         = "Π"

스니펫 코드는 HTML 파일에서 \\pi 의 모든 인스턴스를 &Pi; 로 대체하며, 브라우저에서 볼 때 그리스어 Π 기호로 표시됩니다.

참조: 매크로.

QML 추가

QDoc은 QDoc 주석에 대한 QML 파일을 구문 분석할 수 있습니다. 확장자 유형이 fileextensions 변수에 포함된 경우 QDoc은 확장자가 .qml 인 파일을 구문 분석합니다.

또한 생성된 HTML 파일은 QDoc 구성 파일에 지정된 QML 모듈 이름 뒤에 접두사와 접미사를 가질 수 있습니다.

outputprefixes = QML
outputprefixes.QML = uicomponents-
outputsuffixes = QML
outputsuffixes.QML = -tp

출력 접두사, 출력 접미사참조.