QDoc 시작하기

Qt는 QDoc을 사용하여 문서 세트를 HTML 및 DocBook XML 형식으로 생성합니다. QDoc은 일련의 구성 파일을 사용하여 QDoc 주석에서 문서를 생성합니다. 주석에는 '토픽 ( topics )'이라는 유형이 있으며, 이는 주석이 클래스 문서인지 속성 문서인지를 결정합니다. 또한 주석에는 최종 출력의 레이아웃과 서식을 개선하기 위한 마크업이 포함될 수도 있습니다.

QDoc을 사용하여 문서를 생성하는 데에는 다음 세 가지 필수 요소가 있습니다:

• QDoc 바이너리
• qdocconf 구성 파일
• Documentation C++, , 파일 내의 구성 파일 QML .qdoc

QDoc은 C++ 헤더 및 소스 파일을 파 싱 하고, \fn 명령어 내의 함수 시그니처를 파싱하는 데 Clang이 필요합니다. 자세한 내용은 ‘QDoc용 Clang 설치’를 참조하십시오.

이 섹션에서는 문서 세트를 생성하는 데 필요한 기본 사항을 다룹니다. 또한, 이 가이드에서는 C++이 아닌 API 문서와 QML 문서를 작성할 때 고려해야 할 사항과 옵션을 소개합니다. 마지막으로, 이 가이드에서는 샘플 프로젝트 문서와 QML 유형 문서의 예제를 제공합니다.

QDoc에 대한 구체적인 정보는 QDoc 매뉴얼을 참조하십시오.

챕터

1. QDoc용 Clang 설치
2. QDoc 구성 파일 생성
3. 문서 작성
4. 문서의 범주
   • C++ 문서 작성 스타일
   • QML 문서 작성 스타일
5. QDoc 경고 문제 해결