Категории документации

Существует несколько типов предопределённых категорий или типов документации:

• Руководства по использованию
• Учебник
• Обзор
• Статья
• ЧАВО (Часто задаваемые вопросы)
• Документация API C++
• Документация типа QML
• Пример кода

QDoc может форматировать страницу в зависимости от типа. Кроме того, таблицы стилей могут предоставлять дополнительный контроль над отображением каждой категории.

Документация API

QDoc превосходно справляется с созданием документации API на основе набора исходного кода и документации в комментариях QDoc. В частности, QDoc знает архитектуру Qt и может проверять существование документации Qt C++ класса, функции или свойства. QDoc выдаёт предупреждения и ошибки, если не может сопоставить документацию с кодовым элементом или если кодовый элемент не имеет документации.

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

QDoc будет анализировать заголовочные файлы (обычно .h файлы) для построения дерева структуры классов. Затем QDoc проанализирует исходные и файлы документации, чтобы прикрепить документацию к структуре класса. После этого QDoc сгенерирует страницу для класса.

Примечание: QDoc использует заголовочные файлы для получения информации о классе и не будет правильно обрабатывать комментарии QDoc в заголовочных файлах.

Стили языка

Для создания качественной документации API, справочники Qt API следуют определённым руководящим принципам языка. Хотя содержимое этой страницы демонстрирует, как создавать документацию API, руководящие принципы стиля показывают, как справочные материалы следуют единообразному использованию языка.

• Стиль документации C++
• Стиль документации QML

Документирование типов QML

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

Список команд QDoc, связанных с QML:

• \qmlattachedproperty
• \qmlattachedsignal
• \qmlbasictype
• \qmltype - создаёт документацию типа QML
• \qmlmethod
• \qmlproperty
• \qmlsignal
• \inherits
• \qmlmodule
• \inqmlmodule
• \instantiates

Примечание: Не забудьте включить разбор QML, добавив тип файла *.qml в переменную fileextension.

Для документирования типа QML начните с создания комментария QDoc, который использует команду \qmltype в качестве команды темы.

Парсер QML

Если ваш тип QML определён в файле qml, документируйте его там. Если ваш тип QML представлен классом C++, документируйте его в файле cpp для этого класса C++ и добавьте команду \instantiates, чтобы указать имя класса C++. Не документируйте тип QML в файле cpp, если тип QML определён в файле qml.

При документировании типа QML в файле qml размещайте каждый комментарий QDoc непосредственно над элементом, к которому относится комментарий. Например, поместите комментарий QDoc, содержащий команду \qmltype (комментарий темы), непосредственно над внешним типом QML в файле qml. Поместите комментарий для документирования свойства QML непосредственно над объявлением свойства и так далее для обработчиков сигналов QML и методов QML. Обратите внимание, что при документировании свойств QML в файле qml вы обычно не включаете команду \qmlproperty в качестве команды темы (которую вы должны сделать при документировании типов QML в файлах cpp), потому что парсер QML автоматически связывает каждый комментарий QDoc со следующим объявлением QML, которое он анализирует. То же самое относится к комментариям обработчиков сигналов QML и методов QML. Но иногда полезно включить одну или несколько команд \qmlproperty в комментарий, например, когда тип свойства — другой тип QML, и вы хотите, чтобы пользователь использовал только определённые свойства в этом другом типе QML, а не все из них. Но при документировании свойства, имеющего псевдоним, поместите комментарий QDoc для него непосредственно над объявлением псевдонима. В этих случаях комментарий QDoc обязательно должен содержать команду \qmlproperty, поскольку это единственный способ, которым QDoc может узнать тип алиасированного свойства.

При документировании типа QML в файле cpp соответствующего класса C++ (если он есть), вы обычно помещаете каждый комментарий QDoc непосредственно над документируемым элементом. Однако QDoc не использует парсер QML для анализа этих файлов (используется парсер C++), поэтому эти комментарии QML QDoc могут появляться в любом месте файла cpp. Обратите внимание, что комментарии QML QDoc в файлах cpp обязательно должны использовать команды темы QML. То есть команда \qmltype обязательно должна присутствовать в комментарии QDoc для типа QML, а команда \qmlproperty обязательно должна присутствовать в каждом комментарии QML QDoc для свойства QML.

Модули QML

Тип QML принадлежит к модулю. Модуль может содержать все связанные типы для платформы или содержать определённую версию Qt Quick. Например, типы QML Qt Quick 2 принадлежат модулю Qt Quick 2, а также есть модуль Qt Quick 1 для более старых типов, введённых в Qt 4.

Модули QML позволяют группировать типы QML. Команда темы \qmltype должна иметь контекстную команду \inqmlmodule для связи типа с модулем QML. Аналогично, команда темы \qmlmodule должна существовать в отдельном файле .qdoc для создания страницы обзора модуля. На странице обзора будут перечислены типы QML модуля QML.

Ссылки на типы QML должны также содержать имя модуля. Например, если тип, называемый TabWidget, находится в модуле UIComponents, он должен быть связан как UIComponents::TabWidget.

Только для чтения и внутренние свойства QML

QDoc обнаруживает свойства QML, которые помечены как readonly. Обратите внимание, что свойство должно быть инициализировано значением.

readonly property int sampleReadOnlyProperty: 0

Свойства и сигналы, которые не предназначены для публичного интерфейса, могут быть помечены командой \internal. QDoc не будет публиковать документацию в сгенерированных выходных данных.

Статьи и обзоры

Статьи и обзоры — это стиль написания, наиболее подходящий для предоставления краткой информации о теме или концепции. Он может вводить новую технологию или обсуждать, как может быть применена концепция, но без слишком подробного обсуждения точных шагов. Однако этот тип контента может служить отправной точкой для читателей, чтобы найти учебные и справочные материалы, такие как учебники, примеры и документацию класса. Примером обзора может быть страница продукта, такая как общее обсуждение Qt Quick, отдельных модулей, принципов проектирования или инструментов.

Чтобы указать, что документ является статьёй, добавьте ключевое слово article к команде \page:

/*!
    \page overview-qt-technology.html overview
    \title Overview of a Qt Technology

    \brief provides a technology never seen before.

*/

В разделе записи команд темы приведён список доступных аргументов команды \page.

Учебники, руководства по использованию, ЧАВО

Учебники, руководства по использованию и ЧАВО — это все учебные материалы, которые обучают или предписывают читателю. Учебники — это контент, предназначенный для руководства читателем по прогрессивному пути обучения концепции или технологии. Руководства по использованию и ЧАВО (Часто задаваемые вопросы) предоставляют рекомендации, представляя материал в виде ответов на часто задаваемые вопросы. Руководства по использованию и ЧАВО предназначены для удобного обращения и не обязательно представляются в линейной последовательности.

Для создания этих типов помечайте страницы, указав аргумент type для команды \page. Аргумент type — это второй аргумент, причём имя файла является первым.

/*!
    \page altruism-faq.html faq
    \title Altruism Frequently Asked Questions

    \brief All the questions about altruism, answered.

    ...
*/

В разделе записи команд темы приведён список доступных аргументов команды \page.

Примеры кода

Примеры — эффективный способ продемонстрировать практическое применение той или иной технологии или концепции. Что касается программного обеспечения, это обычно в виде приложения, использующего простой код и ясные объяснения того, что делает код. Любой модуль, API, проект, шаблон и т. д. должен иметь как минимум один хороший пример.

Пример может иметь сопроводительный учебник. Учебник инструктирует и описывает код, в то время как пример кода — это содержимое кода, которое могут изучить пользователи. К примерам кода могут прилагаться тексты, которые не находятся в руководстве.

QDoc создаст страницу, содержащую пример кода с описанием, используя команду \example.

/*!
    \title UI Components: Tab Widget Example
    \example declarative/ui-components/tabwidget

    This example shows how to create a tab widget. It also demonstrates how
    \l {Property aliases}{property aliases} and
    \l {Introduction to the QML Language#Default Properties}{default properties} can be used to collect and
    assemble the child items declared within an \l Item.

    \image qml-tabwidget-example.png
*/

QDoc будет использовать каталог, указанный в переменной ввода exampledirs, для поиска файла проекта Qt (.pro) для генерации файлов примера. Сгенерированный HTML будет иметь имя файла declarative-ui-components-tabwidget.html. QDoc также перечислит весь пример кода.

Примечание: Файл проекта примера должен совпадать с именем каталога.