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

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

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

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

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

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

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

QDoc будет анализировать заголовочные файлы (обычно .h файлы) для построения дерева структуры классов. Затем 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 начните с создания комментария 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.

Учебники, руководства, FAQ

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

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