Начало работы с 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