Начало работы с 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
5. Пример документации QML