Разное

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

\annotatedlist

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

/ *!
    ...
    \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:

/ *!
    \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 использует его для генерации страницы Обзоры таким образом:

/ *!
    \page overviews.html

    \title All Overviews and HOWTOs

    \generatelist overviews
* /

attributions

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

related

Аргумент related используется в сочетании с командами \group и \ingroup, чтобы перечислить все обзоры, относящиеся к указанной группе. Например, страница для страницы Программирование с 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. Это может быть любой исходный файл, обрабатываемый 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 filename snippet-identifier

Потратить время на создание отдельного .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 в основном используется для включения метаданных в файлы DITA XML. Она также используется для добавления метаданных к документации примеров и для задания авторов класса C++ при генерации HTML-вывода.

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

/ *!
    \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, пример выше не повлияет на сгенерированный вывод, но если вы запустите QDoc для генерации DITA XML, пример сгенерирует следующее:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cxxClass PUBLIC "-//NOKIA//DTD DITA C++ API Class Reference Type v0.6.0//EN" "dtd/cxxClass.dtd">
<!--qwidget.cpp-->
<cxxClass id="id-9a14268e-6b09-4eee-b940-21a00a0961df">
   <apiName>QWidget</apiName>
   <shortdesc>the QWidget class is the base class of all user interface objects.</shortdesc>
   <prolog>
       <author>Qt Development Frameworks</author>
       <publisher>Qt Project</publisher>
       <copyright>
           <copyryear year="2018"/>
           <copyrholder>Qt Project</copyrholder>
       </copyright>
       <permissions view="all"/>
       <metadata>
           <audience type="designer"/>
           <audience type="programmer"/>
           <audience type="user"/>
           <category>Class reference</category>
           <prodinfo>
               <prodname>Qt Reference Documentation</prodname>
               <vrmlist>
                   <vrm version="4" release="7" modification="3"/>
               </vrmlist>
               <component>QtGui</component>
           </prodinfo>
           <othermeta name="platform" content="MeeGo"/>
           <othermeta name="platform" content="macOS 10.6"/>
           <othermeta name="technology" content="User Interface"/>
       </metadata>
   </prolog>

В примере вывода несколько значений были установлены с использованием значений по умолчанию, полученных из файла конфигурации QDoc. Подробности см. в разделе Генерация вывода DITA XML.

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

Другое применение команды \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, игнорируются.

\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 разграничивают блок исходного кода языка разметки.

Примечание: По возможности избегайте использования этой команды, так как она генерирует код DITA XML, который вызывает проблемы. Если вы пытаетесь получить специальное поведение таблицы или списка, попробуйте получить желаемое поведение с помощью команд \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