Разное

Эти команды предоставляют различные функции, связанные с визуальным представлением документации и процессом ее генерации.

\annotatedlist

Команда \annotatedlist генерирует список членов группы, каждый член с его кратким описанием. Ниже приведен пример из документации Qt Reference:

/ *!
    ...
    \section1 Drag and Drop Classes

    These classes deal with drag and drop and the necessary mime type
    encoding and decoding.

    \annotatedlist draganddrop

* /

Это генерирует список всех C++ классов и/или QML типов в группе draganddrop. C++ класс или QML тип в группе draganddrop будет содержать \ingroup draganddrop в его комментарии \class или \qmltype.

\generatelist

Команда \generatelist генерирует список ссылок на сущности документации в группе. Ниже приведен пример из документации Qt Reference:

/ *!
    \page classes.html
    \title All Classes

    For a shorter list that only includes the most
    frequently used classes, see \l{Qt's Main Classes}.

    \generatelist classes Q
* /

Это генерирует страницу Все классы. Команда принимает следующие аргументы:

annotatedclasses

Аргумент annotatedclasses предоставляет таблицу, содержащую имена всех классов и описание каждого класса. Каждое имя класса является ссылкой на страницу справочной документации класса. Например:

C++ класс документируется с помощью команды \class. Аннотация класса берется из аргумента команды \brief в комментарии класса.

annotatedexamples

Аргумент annotatedexamples предоставляет полный список всех примеров в виде набора таблиц, содержащих заголовки всех примеров и описание каждого из них. Каждый заголовок является ссылкой на документацию примера.

Для каждого модуля (который имеет документированные примеры) генерируется отдельная таблица, при условии, что модуль определил переменную конфигурации navigation.landingpage. Переменная landingpage используется в качестве заголовка, предшествующего каждой таблице.

annotatedattributions

Аргумент annotatedattributions предоставляет полный список всех атрибуций в виде набора таблиц, содержащих заголовки всех атрибуций и описание каждой атрибуции. Каждый заголовок является ссылкой на страницу атрибуции.

Для каждого модуля (имеющего атрибуции) генерируется отдельная таблица, при условии, что модуль определил переменную конфигурации navigation.landingpage. Переменная landingpage используется в качестве заголовка, предшествующего каждой таблице.

classes <prefix>

Аргумент classes предоставляет полный алфавитный список классов. Второй аргумент, <prefix>, является общим префиксом для имён классов. Имена классов будут отсортированы по символу, следующему за общим префиксом. Например, общим префиксом для классов Qt является Q. Аргумент общего префикса является необязательным. Если общий префикс не указан, имена классов будут отсортированы по их первому символу.

Каждое имя класса становится ссылкой на страницу справочной документации класса. Эта команда используется для генерации страницы Все классы таким образом:

/ *!
    \page classes.html
    \title All Classes
    \ingroup classlists

    \brief Alphabetical list of classes.

    This is a list of all Qt classes. For classes that
    have been deprecated, see the \l{Obsolete Classes}
    list.

    \generatelist classes Q
* /

C++ класс документируется с помощью команды \class.

classesbymodule

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

Например, эту команду можно использовать на странице модуля следующим образом:

/ *!
    \page phonon-module.html
    \module Phonon
    \title Phonon Module
    \ingroup modules

    \brief Contains namespaces and classes for multimedia functionality.

    \generatelist{classesbymodule Phonon}

...

* /

Каждый класс, являющийся членом указанного модуля, должен быть помечен командой \inmodule в его комментарии \class.

qmltypesbymodule

Аналогично аргументу classesbymodule, но используется для перечисления QML типов из QML модуля, указанного вторым аргументом.

Примечание: Поддержка этого аргумента была добавлена в QDoc 5.6.

jstypesbymodule

Аналогично аргументу classesbymodule, но используется для перечисления JavaScript типов из модуля, указанного вторым аргументом.

Примечание: Поддержка этого аргумента была добавлена в QDoc 5.6.

examplefiles [regular_expression]

Аргумент examplefiles перечисляет файлы, которые являются частью проекта примера. Необязательный второй аргумент — регулярное выражение; если он указан, то перечисляются только файлы, путь которых соответствует регулярному выражению.

Аргумент examplefiles может использоваться только в документации примеров (см. \example) и обычно используется вместе с командой \noautolist.

exampleimages [regular_expression]

Аргумент exampleimages перечисляет изображения, которые являются частью проекта примера. Необязательный второй аргумент — регулярное выражение; если он указан, то перечисляются только файлы изображений, путь которых соответствует регулярному выражению.

Аргумент exampleimages может использоваться только в документации примеров (см. \example) и обычно используется вместе с командой \noautolist.

functionindex

Аргумент functionindex предоставляет полный алфавитный список всех документированных функций-членов. Обычно используется только для генерации страницы Индекс функций Qt таким образом:

/ *!
    \page functions.html
    \title All Functions
    \ingroup funclists

    \brief All documented Qt functions listed alphabetically with a
    link to where each one is declared.

    This is the list of all documented member functions and global
    functions in the Qt API. Each function has a link to the
    class or header file where it is declared and documented.

    \generatelist functionindex
* /

legalese

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

overviews

Аргумент overviews используется для того, чтобы сообщить QDoc о генерации списка, объединяя содержимое всех страниц \group. Qt использует его для генерации страницы overviews таким образом:

/ *!
    \page overviews.html

    \title All Overviews and HOWTOs

    \generatelist overviews
* /

attributions

Аргумент attributions используется для того, чтобы сообщить QDoc о генерации списка атрибуций в документации.

related

Аргумент related используется в сочетании с командами \group и \ingroup для перечисления всех обзоров, связанных с заданной группой. Например, страница для страницы Programming with Qt генерируется следующим образом:

/ *!
    \group qt-basic-concepts
    \title Programming with Qt

    \brief The basic architecture of the Qt cross-platform application and UI framework.

    Qt is a cross-platform application and UI framework for
    writing web-enabled applications for desktop, mobile, and
    embedded operating systems. This page contains links to
    articles and overviews explaining key components and
    techniuqes used in Qt development.

    \generatelist {related}
* /

Каждая страница, перечисленная на этой странице группы, содержит команду:

\ingroup qt-basic-concepts

\if

Команда \if и соответствующая команда \endif заключают части комментария QDoc, которые будут включены только в том случае, если условие, указанное в аргументе команды, истинно.

Команда считывает остальную часть строки и обрабатывает её как оператор C++ #if.

/ *!
    \if defined(opensourceedition)

    \note This edition is for the development of
    \l{Qt Open Source Edition} {Free and Open Source}
    software only; see \l{Qt Commercial Editions}.

    \endif
* /

Этот комментарий QDoc будет отображен только в том случае, если препроцессорный символ opensourceedition определен и указан в переменной defines в файле конфигурации, чтобы QDoc обработала код внутри #ifdef и #endif:

defines = opensourceedition

Вы также можете определить препроцессорный символ вручную в командной строке. Более подробная информация содержится в документации переменной defines.

См. также \endif, \else, defines и falsehoods.

\endif

Команда \endif и соответствующая команда \if заключают части комментария QDoc, которые будут включены, если условие, указанное в аргументе команды \if, истинно.

Дополнительную информацию см. в документации команды \if.

См. также \if, \else, defines и falsehoods.

\else

Команда \else определяет альтернативу, если условие в команде \if ложно.

Команда \else может использоваться только внутри команд \if...\endif, но она полезна, когда существует только две альтернативы.

\include

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

Команда полезна, когда фрагмент команд или текста должен использоваться в нескольких местах в документации. Используйте команду \include везде, где вы хотите вставить фрагмент в документацию. Файл, содержащий фрагмент для включения, должен находиться по пути (путям), указанным в переменной конфигурации QDoc sourcedirs или exampledirs. Это может быть любой файл источника, проанализированный QDoc (или даже тот же, где используется команда \include), или любой другой текстовый файл. Для хранения фрагментов в отдельном файле, который не предназначен для обработки QDoc, используйте расширение файла, которое не указано в sources.fileextensions; например, .qdocinc.

Команда может иметь один или два аргумента. Первый аргумент всегда имя файла. Содержимое файла должно быть входными данными QDoc, то есть последовательностью команд и текста QDoc, но без заключительных разделителей комментариев QDoc /*! ... */. Если вы хотите включить весь файл с указанным именем, не используйте второй аргумент. Если вы хотите включить только часть файла, см. форму с двумя аргументами ниже. Вот пример формы с одним аргументом:

/ *!
    \page corefeatures.html
    \title Core Features

    \include examples/signalandslots.qdocinc
    \include examples/objectmodel.qdocinc
    \include examples/layoutmanagement.qdocinc
* /

QDoc отображает эту страницу как показано здесь.

\include имя_файла фрагмент-идентификатор

Впустую тратить время на создание отдельного .qdocinc файла для каждого фрагмента включения QDoc, который вы хотите использовать в нескольких местах документации, особенно с учётом необходимости размещать уведомление об авторских правах/лицензии в каждом из этих файлов. Поэтому, если у вас много фрагментов для включения, вы можете поместить их все в один файл, если хотите, и заключить каждый из них в:

    //! [snippet-id1]

       QDoc commands and text...

//! [snippet-id1]

    //! [snippet-id2]

       More QDoc commands and text...

//! [snippet-id2]

Затем вы можете использовать форму команды с двумя аргументами:

\input examples/signalandslots.qdocinc snippet-id2
\input examples/objectmodel.qdocinc another-snippet-id

Она работает как ожидается. Последовательность команд и текста QDoc, находящихся между двумя тегами с тем же именем, что и второй аргумент, передаётся в поток входных данных QDoc. Вы даже можете иметь вложенные фрагменты.

Примечание: Идентификаторы фрагментов работают также внутри блоков комментариев документации (/*! .. */), поэтому нет необходимости использовать отдельный .qdocinc файл. При обработке блока комментариев QDoc удаляет любые //! строки комментариев из сгенерированного вывода.

\meta

Команда \meta используется для добавления метаданных к документации примеров и при генерации HTML-вывода для указания создателей класса C++.

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

/ *!
    \class QWidget
    \brief The QWidget class is the base class of all user interface objects.

    \ingroup basicwidgets

    \meta {technology} {User Interface}
    \meta {platform} {macOS 10.6}
    \meta {platform} {MeeGo}
    \meta {audience} {user}
    \meta {audience} {programmer}
    \meta {audience} {designer}
* /

При запуске QDoc для генерации HTML, пример выше не повлияет на сгенерированный вывод.

Пример метаданных

Другое применение команды \meta — включение метаданных (тегов) в \example документацию. По умолчанию QDoc генерирует теги примеров на основе заголовка примера \title и имени модуля. Эти теги отображаются в режиме «Добро пожаловать» Qt Creator, помогая пользователям перемещаться по списку примеров.

Дополнительные теги можно создать с помощью \\meta {tag} {tag1,[tag2,...]}. Например:

/ *!
    \example helloworld
    \title Hello World Example
    \meta {tag} {tutorial,basic}
* /

Это приведет к следующим тегам: tutorial,basic,hello,world. Общие слова, такие как example, игнорируются.

Пример путей установки

Команда \meta в сочетании с аргументом installpath указывает расположение установленного примера. Это значение переопределяет значение, установленное с помощью переменной конфигурации examplesinstallpath.

/ *!
    \example helloworld
    \title Hello World Example
    \meta {installpath} {tutorials}
* /

См. также examplesinstallpath.

\noautolist

Команда \noautolist указывает на то, что аннотированный список классов C++ или типов QML, автоматически генерируемый в нижней части страницы модуля C++ или QML, должен быть пропущен, потому что классы или типы были перечислены вручную. Эта команда также может быть использована с командой \group для пропуска списка членов группы, когда они перечислены вручную.

Команда должна стоять на отдельной строке. См. Типы QML Qt Sensors для примера. Страница сгенерирована из qtsensors5.qdoc. Там вы найдёте комментарий QDoc, содержащий команду \qmlmodule для модуля QtSensors. Тот же комментарий QDoc содержит две команды \annotated-list для перечисления типов QML в двух отдельных группах. Типы QML были разделены на эти две группы, потому что так их перечислять понятнее, чем в одном алфавитном списке. В нижней части комментария используется \noautolist для указания QDoc на то, что не нужно генерировать автоматический аннотированный список.

Эта команда была введена в QDoc 5.6.

Начиная с Qt 5.10, эта команда также может быть применена к \example документации, где она приводит к пропуску автоматически сгенерированного списка файлов и изображений, относящихся к проекту примера.

\omit

Команда \omit и соответствующая ей команда \endomit разделяют части документации, которые вы хотите, чтобы QDoc пропустил. Например:

/ *!
    \table
    \row
        \li Basic Widgets
        \li Basic GUI widgets such as buttons, comboboxes
           and scrollbars.

    \omit
    \row
        \li Component Model
        \li Interfaces and helper classes for the Qt
           Component Model.
    \endomit

    \row
        \li Database Classes
        \li Database related classes, e.g. for SQL databases.
    \endtable
* /

QDoc отображает это как:

\raw (avoid)

Команда \raw и соответствующая ей команда \endraw разделяют блок кода языка разметки в сыром виде.

Примечание: Старайтесь избегать использования этой команды, если это возможно. Если вы пытаетесь получить специальное поведение таблиц или списков, попробуйте получить желаемое поведение с помощью команд \span и \div в своих командах \table или \list.

Команда принимает аргумент, определяющий формат кода. В настоящее время единственный поддерживаемый формат — HTML.

Команда \raw полезна, если вы хотите получить некоторые специальные эффекты HTML в своей документации.

/ *!
    Qt has some predefined QColor objects.

    \raw HTML
    <style type="text/css" id="colorstyles">
    #color-blue { background-color: #0000ff; color: #ffffff }
    #color-darkBlue { background-color: #000080; color: #ffffff }
    #color-cyan { background-color: #00ffff; color: #000000 }
    </style>

    <p>
    <tt id="color-blue">Blue(#0000ff)</tt>,
    <tt id="color-darkBlue">dark blue(#000080)</tt> and
    <tt id="color-cyan">cyan(#00ffff)</tt>.
</p>
    \endraw
* /

QDoc отображает это как:

Qt имеет некоторые предопределенные объекты QColor.

Синий(#0000ff), тёмно-синий(#000080) и голубой(#00ffff).

Примечание: Но вы можете добиться того же самого, используя команды QDoc. В этом случае вам нужно только включить стили цветов в свой файл style.css. Затем вы можете написать:

\tt {\span {id="color-blue"} {Blue(#0000ff)}},
\tt {\span {id="color-darkBlue"} {dark blue(#000080)}} and
\tt {\span {id="color-cyan"} {cyan(#00ffff)}}.

...что отображается как:

Blue(#0000ff), dark blue(#000080) и cyan(#00ffff).

\unicode

Команда \unicode позволяет вставлять произвольный символ Юникода в документ.

Команда принимает аргумент, определяющий символ как целое число. По умолчанию используется основание 10, если не указан префикс '0x' или '0' (соответственно для оснований 16 и 8). Например:

O G\unicode{0xEA}nio e as Rosas

\unicode 0xC0 table en famille avec 15 \unicode 0x20AC par jour

\unicode 0x3A3 \e{a}\sub{\e{i}}

QDoc отображает это как:

O Gênio e as Rosas

À table en famille avec 15 € par jour

Σ a_i