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

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

• Руководства по выполнению
• Учебник
• Обзор
• Статья
• ЧАВО (Часто задаваемые вопросы)
• Документация 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.

Примеры кода

Примеры — эффективный способ продемонстрировать практическое использование заданной технологии или концепции. В случае с middleware это обычно в форме приложения, использующего простой код и чёткие объяснения того, что делает код. Любой модуль, 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 Project (.pro) для генерации файлов примера. Сгенерированный HTML будет иметь имя файла declarative-ui-components-tabwidget.html. QDoc также перечислит весь пример кода.

Примечание: Файл проекта примера должен быть таким же, как имя каталога.