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

Комментарии 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
*/

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