Написание документации

Комментарии QDoc

Документация содержится внутри комментариев QDoc, ограниченных комментариями /*! и */. Обратите внимание, что это допустимые комментарии в C++, QML и JavaScript.

Внутри комментария QDoc используется //! в качестве однострочного комментария документации; сам комментарий и все, что следует за ним, до новой строки, исключаются из генерируемого вывода.

QDoc будет анализировать файлы C++ и QML в поисках комментариев qdoc. Чтобы явно исключить определенный тип файла, исключите его из файла конфигурации.

Команды QDoc

QDoc использует команды для получения информации о документации. Topic команды определяют тип элемента документации, context команды предоставляют подсказки и информацию о теме, а markup команды предоставляют информацию о том, как QDoc должен отформатировать фрагмент документации.

Темы QDoc

Каждый комментарий qdoc должен иметь тип темы. Тема отличает его от других тем. Для указания типа темы используйте одну из нескольких команд тем.

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

Пример команд тем:

• \enum - для документации перечислений
• \class - для документации класса C++
• \qmltype - для документации типа QML
• \page - для создания страницы.

Команда \page предназначена для создания статей, которые не являются частью документации исходного кода. Команда также может принимать два аргумента: имя файла статьи и тип документации. Возможные типы:

• howto
• overview
• tutorial
• faq
• article - по умолчанию, когда тип не указан

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

    \brief All the questions about altruism, answered.

    ...
*/

На странице Команды тем содержится информация обо всех доступных командах тем.

Контексты тем

Команды контекста дают QDoc подсказку о контексте темы. Например, если функция C++ устарела, то она должна быть помечена как устаревшая с помощью команды \obsolete. Аналогично, навигация по страницам и заголовок страницы предоставляют QDoc дополнительную информацию о странице.

QDoc будет создавать дополнительные ссылки или страницы для этих контекстов. Например, группа создается с помощью команды \group, а члены имеют команду \ingroup. Имя группы указывается в качестве аргумента.

На странице Команды контекста приведен список всех доступных команд контекста.

Разметка документации

QDoc может выполнять разметку текста, аналогично другим инструментам разметки или документирования. QDoc может пометить часть текста жирным шрифтом, когда текст размечается с помощью команды \b.

\b{This} text will be in \b{bold}.

На странице Команды разметки приведен полный список доступных команд разметки.

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

По существу, для создания страницы QDoc должны присутствовать некоторые основные компоненты.

• Назначьте тему для комментария QDoc - Комментарий может быть страницей, документированием свойства, документированием класса или любой из доступных команд тем.
• Придайте теме контекст - QDoc может ассоциировать определенные темы с другими страницами, например, ассоциировать устаревшие функции, когда документация помечена с помощью \obsolete.
• Пометьте разделы документа с помощью команд разметки - QDoc может создавать макеты и форматировать документацию для документации.

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

/*!
    \class QVector3D
    \brief The QVector3D class represents a vector or vertex in 3D space.
    \since 4.6
    \ingroup painting-3D

    Vectors are one of the main building blocks of 3D representation and
    drawing.  They consist of three coordinates, traditionally called
    x, y, and z.

    The QVector3D class can also be used to represent vertices in 3D space.
    We therefore do not need to provide a separate vertex class.

    \note By design values in the QVector3D instance are stored as \c float.
    This means that on platforms where the \c qreal arguments to QVector3D
    functions are represented by \c double values, it is possible to
    lose precision.

    \sa QVector2D, QVector4D, QQuaternion
*/

У него есть конструктор QVector3D::QVector3D(), который был документирован с помощью следующего комментария QDoc:

/*!
    \fn QVector3D::QVector3D(const QPoint& point)

    Constructs a vector with x and y coordinates from a 2D \a point, and a
    z coordinate of 0.
*/

Разные комментарии могут находиться в разных файлах, и QDoc соберет их в зависимости от их темы и контекста. Результирующая документация из фрагментов генерируется в документацию класса QVector3D.

Обратите внимание, что если документация непосредственно предшествует функции или классу в исходном коде, то ей не нужно задавать тему. QDoc будет предполагать, что документация над кодом является документацией для этого кода.

Статья создается с помощью команды \page. Первый аргумент - это HTML-файл, который QDoc создаст. Тема дополняется командами контекста, командами \title и \nextpage. Есть и другие команды QDoc, такие как команда \list.

/*!
    \page generic-guide.html
    \title Generic QDoc Guide
    \nextpage Creating QDoc Configuration Files
    There are three essential materials for generating documentation with qdoc:

    \list
        \li \c qdoc binary
        \li \c qdocconf configuration files
        \li \c Documentation in \c C++, \c QML, and \c .qdoc files
    \endlist
*/

Раздел о командах тем предоставляет обзор нескольких других типов тем.