QDoc 시작하기

Qt는 QDoc을 사용하여 HTML 및 DocBook XML 형식으로 문서 세트를 생성합니다. QDoc은 구성 파일 세트를 사용하여 QDoc 주석에서 문서를 생성합니다. 주석에는 주석이 클래스 문서인지 속성 문서인지를 결정하는 토픽이라는 유형이 있습니다. 또한 주석에는 최종 출력물의 레이아웃과 서식을 향상시키기 위한 마크업이 있을 수 있습니다.

QDoc으로 문서를 생성하는 데 필수적인 세 가지 자료가 있습니다:

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

이 섹션에서는 문서 집합을 만드는 데 필요한 기본 사항을 다루고자 합니다. 또한 이 가이드에서는 비 C++ API 문서와 QML 문서를 문서화할 때 특별히 고려해야 할 사항과 옵션을 제시합니다. 마지막으로 이 가이드는 샘플 프로젝트 문서와 QML 유형 문서의 예시를 제공합니다.

구체적인 QDoc 정보는 QDoc 매뉴얼을 참조하세요.

챕터

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