파생 프로젝트 지원

일부 구성 변수를 사용하면 QDoc을 사용하여 Qt 기반 프로젝트를 지원할 수 있습니다. 이러한 변수를 사용하면 프로젝트에 온라인 Qt 문서 링크를 포함할 수 있으므로 명시적인 링크 명령 없이도 QDoc이 클래스 참조 문서에 대한 링크를 생성할 수 있습니다.

설명

description 변수는 연관된 프로젝트에 대한 간단한 설명을 저장합니다.

프로젝트도 참조하세요.

indexes

indexes 변수는 로드할 인덱스 파일의 경로 집합을 정의합니다.

indexes = \
    $QT_INSTALL_DOCS/qtcore/qtcore.index \
    $SOME_OTHER_PROJECT/doc/foo.index

indexes 변수는 프로젝트의 종속성을 정의할 때 depends 대신 사용할 수 있습니다. 직접 경로가 제공되므로 QDoc을 호출할 때 -indexdir 명령줄 옵션이 필요하지 않습니다.

두 변수 중 하나를 사용하여 종속성을 정의할 수 있습니다. Qt XML 문서에서는 depends 변수만 사용합니다.

의존성, 프로젝트 및 URL도 참조하십시오.

project

project 변수는 .qdocconf 파일과 연결된 프로젝트의 이름을 제공합니다. 이 변수는 모든 프로젝트에서 설정해야 하는 필수 변수입니다.

프로젝트 이름은 연결된 프로젝트의 인덱스 파일의 파일 이름을 구성하는 데 사용됩니다.

project = QtCreator

이렇게 하면 qtcreator.index 이라는 인덱스 파일이 생성됩니다.

프로젝트 이름에 공백이나 특수 문자가 포함되어 있으면 생성된 인덱스 파일 이름에서 대시('-')로 바뀝니다.

종속, 인덱스 및 설명도 참조하세요.

url

url 변수는 현재 프로젝트와 관련된 문서의 기본 URL을 저장합니다.

URL은 프로젝트에 대해 생성된 인덱스 파일에 저장됩니다. 인덱스를 단독으로 사용하는 경우 QDoc은 인덱스에 나열된 클래스, 함수 및 기타 항목에 대한 링크를 구성할 때 이를 기본 URL로 사용합니다.

project     = QtCore
description = Qt Core Reference Documentation
url         = https://doc.qt.io/qt/

...

따라서 QDoc이 Qt Core 모듈의 엔티티에 대한 참조를 생성할 때마다 기본 URL은 https://doc.qt.io/qt/ 이 됩니다.

의존, 인덱스 및 url.examples도 참조하세요.

url.examples

url.examples 변수는 현재 프로젝트와 연결된 예제의 기본 URL을 저장합니다.

이 변수를 정의하면 각 예제 문서 페이지 끝에 예제 프로젝트 디렉터리로 연결되는 링크가 생성됩니다. url.examples 변수는 이 프로젝트와 관련된 예제의 루트 디렉터리를 가리키며, 온라인 리포지토리( http:// 또는 https:// 로 시작) 또는 로컬 파일 시스템(file://)에 대한 링크가 될 수 있습니다.

url.examples 가 정의되지 않은 경우 QDoc은 대신 예제의 파일 및 이미지 목록을 출력합니다.

예를 들어 다음과 같은 정의가 주어집니다:

url.examples = "https://code.qt.io/cgit/qt/qtbase.git/tree/examples/"
examplesinstallpath = corelib

그런 다음 다음 \example 명령을 입력합니다:

/*!
    \example threads/semaphores
    ...
*/

QDoc은 https://code.qt.io/cgit/qt/qtbase.git/tree/examples/corelib/threads/semaphores 에 대한 링크를 생성합니다.

URL에 예제 경로 뒤에 더 많은 구성 요소(예: 쿼리 문자열)가 포함되어 있는 경우 \1을 경로의 자리 표시자로 사용할 수 있습니다:

url.examples = "https://code.qt.io/cgit/qt/qtbase.git/tree/examples/\1?h=$QT_VER"
examplesinstallpath = corelib

위와 동일한 \example 명령이 주어지고 $QT_VER 이 5.13 으로 확장된다고 가정하면 생성된 URL은 https://code.qt.io/cgit/qt/qtbase.git/tree/examples/corelib/threads/semaphores?h=5.13 입니다.

url.examples 변수는 QDoc 버전 5.13에 도입되었습니다.

url, examplesinstallpath 및 \example도 참조하세요.

파생된 프로젝트를 지원하는 방법

이 기능은 QDoc이 Qt 참조 문서를 생성할 때 생성된 포괄적인 인덱스를 사용합니다.

예를 들어, qtgui.qdocconf ( Qt GUI)의 구성 파일에는 다음과 같은 변수 정의가 포함되어 있습니다:

project     = QtGui
description = Qt GUI Reference Documentation
url         = http://doc.qt.io/qt/

...

프로젝트 변수 이름은 인덱스 파일의 파일 이름을 형성하는 데 사용되며, 이 경우 qtgui.index 파일이 생성됩니다. URL은 인덱스 파일에 저장됩니다. 이후 QDoc은 인덱스에 나열된 클래스, 함수 및 기타 항목에 대한 링크를 구성할 때 이를 기본 URL로 사용합니다.

의존, 인덱스, 프로젝트 및 URL도 참조하세요.