매크로

매크로 변수를 사용하여 자신만의 간단한 QDoc 명령어를 만들 수 있습니다.

매크로는 다음과 같은 용도로 유용합니다:

• 서식이 지정된 텍스트 스니펫과 같이 반복적으로 사용되는 텍스트를 문서에 포함시키는 경우.
• 빌드 시스템에서 버전 문자열과 같은 정보를 .documentation 파일로 가져오는 경우.
• 제품명과 같이 향후 변경될 가능성이 높은 문자열을 한 곳에서 관리하기.
• 용어나 제품 이름이 일관되게 사용되도록 보장합니다.
• 강제 줄바꿈이나 특수 문자와 같은 HTML 및 DocBook 요소를 사용하여 생성된 문서의 스타일을 지정하는 것.
• 예를 들어, 탭을 사용하여 다양한 프로그래밍 언어, 운영 체제 또는 도구에 대한 콘텐츠 예제를 표시합니다.

전역 매크로

모든 문서 프로젝트에서 사용할 수 있는 미리 정의된 전역 매크로 세트와 해당 현재 값에 대해서는 /qtbase/doc/global/macros.qdocconf 및 /qtbase/doc/global/htmltabs.qdocconf를 참조하십시오. 여기에는 다음과 같은 매크로가 포함되어 있습니다:

• CMake 텍스트 스니펫
• HTML 및 DocBook 서식 지정
• 제품 이름
• 제품 버전
• 탭으로 구분된 콘텐츠
• YouTube 콘텐츠 링크
• 기타 매크로

Qt Online Installer 는 매크로 파일을 Qt 설치 폴더로 복사하므로, 소스 코드에서 직접 QDoc을 빌드하는 대신 설치된 Qt를 사용하여 QDoc으로 문서를 빌드하는 경우에도 매크로를 사용할 수 있습니다.

매크로 추가

특정 문서 프로젝트에 대한 매크로는 해당 프로젝트의 .qdocconf 파일이나 프로젝트에 포함된 .qdocconf 파일에 추가할 수 있습니다. 매크로가 여러 문서 프로젝트에서 유용하게 사용될 수 있다면, 전역 매크로 파일에 추가하십시오.

매크로 구문 및 옵션에 대한 자세한 내용은 macro를 참조하십시오.

매크로 사용

다음과 같이 내장된 QDoc 명령과 동일한 방식으로 매크로를 사용할 수 있습니다:

• 코드 소스 파일 내의 문서 주석 (.cpp, .qml)
• 문서 소스 파일(.qdoc, .qdocinc)

예를 들어:

\QOI copies the macros files to your Qt installation folder.

사용되지 않는 매크로

전역 매크로 파일에는 이전 문서 세트와의 호환성을 위해 다음과 같은 더 이상 사용되지 않는 매크로들이 포함되어 있습니다.