Начало работы с QDoc

Qt использует QDoc для генерации документации в формате HTML и DITA XML. QDoc использует набор конфигурационных файлов для генерации документации из комментариев QDoc. Комментарии имеют типы, называемые темами, которые определяют, является ли комментарий документацией класса или документацией свойства. Комментарий также может содержать разметку для улучшения макета и форматирования конечного результата.

Для генерации документации с помощью QDoc необходимы три основных компонента:

• QDoc двоичные файлы
• qdocconf конфигурационные файлы
• Documentation в файлах C++, QML, и .qdoc

Примечание: Начиная с Qt 5.11, QDoc требует Clang для парсинга заголовков и исходных файлов C++, а также для парсинга сигнатур функций в командах \fn. Подробности см. в разделе Установка Clang для QDoc.

Этот раздел предназначен для освещения основных потребностей при создании набора документации. Кроме того, руководство рассматривает особые моменты и варианты документирования API, не относящихся к C++, а также документации QML. В заключение, руководство предоставит пример документации проекта и пример документации типа QML.

Для получения конкретной информации о QDoc, обратитесь к Руководству QDoc.

Главы

1. Установка Clang для QDoc
2. Создание конфигурационных файлов QDoc
3. Написание документации
4. Категории документации
   • Стиль документации C++
   • Стиль документации QML