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

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

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

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

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

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

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

Главы

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