Специальное содержимое

Содержимое документа содержит команды, определяющие части документации, части со специальным отображением, концептуальным значением или функцией.

\quotation

Команды \quotation и \endquotation задают длинную цитату.

Текст в ограниченном блоке окружен тегами <blockquote> и </blockquote> в выходном HTML-коде, например:

/ *!
  Although the prospect of a significantly broader market is
  good news for Firstlogic, the notion also posed some
  challenges. Dave Dobson, director of technology for the La
  Crosse, Wisconsin-based company, said:

  \quotation
     As our solutions were being adopted into new
     environments, we saw an escalating need for easier
     integration with a wider range of enterprise
     applications.
  \endquotation
* /

Текст в блоке \quotation будет отображаться в сгенерированном HTML как:

<blockquote>
  <p>As our solutions were being adopted into new environments,
  we saw an escalating need for easier integration with a wider
  range of enterprise applications.</p>
    </blockquote>

Встроенный стиль для большинства браузеров отображает содержимое тега <blockquote> с отступами слева и справа. Приведенный выше пример отобразится как:

По мере внедрения наших решений в новые среды мы видели возрастающую потребность в более легкой интеграции с более широким спектром корпоративных приложений.

Но вы можете переопределить тег <blockquote> в файле style.css.

\footnote

Команды \footnote и \endfootnote задают сноску.

Сноска отображается внизу страницы.

Предупреждение: Команды \footnote и \endfootnote не реализованы. Сноска отображается как обычный HTML-абзац.

\note

Команда \note определяет новый абзац, предваряемый «Примечание:», нажирным шрифтом.

\tableofcontents

Команда \tableofcontents отключена, так как QDoc теперь автоматически генерирует оглавление.

Автоматически сгенерированное оглавление отображается в правом верхнем углу страницы.

\brief

Команда \brief вводит однопредложное описание класса, пространства имен, заголовочного файла, свойства или переменной.

Текст краткого описания используется для представления документации связанного объекта и в списках, сгенерированных с помощью команды \generatelist и команды \annotatedlist.

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

Когда команда \brief используется для описания свойства или переменной, текст краткого описания должен быть фрагментом предложения, начинающимся со слова «является» (для булевского свойства или переменной) или со слова «это» (для любого другого свойства или переменной).

Например, булевское свойство QWidget::isWindow:

/ *!
    \property QWidget::isActiveWindow
    \brief Whether this widget's window is the active window.

    The active window is the window that contains the widget that
    has keyboard focus.

    When popup windows are visible, this property is \c true
    for both the active window \e and the popup.

    \sa activateWindow(), QApplication::activeWindow()
* /

и свойство QWidget::geometry

/ *!
    \property QWidget::geometry
    \brief The geometry of the widget relative to its parent and
    excluding the window frame.

    When changing the geometry, the widget, if visible,
    receives a move event (moveEvent()) and/or a resize
    event (resizeEvent()) immediately.

    ...

   \sa frameGeometry(), rect(), ...
* /

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

geometry : QRect

Это свойство содержит геометрию виджета относительно его родителя и без учета рамки окна.

...

Функции доступа:

• const QRect & geometry () const
• void setGeometry ( int x, int y, int w, int h )
• void setGeometry ( const QRect & )

См. также frameGeometry(), rect(), ...

Когда команда \brief используется для описания класса, рекомендуется использовать полное предложение, например:

The <classname> class is|provides|contains|specifies...

Предупреждение: Не повторяйте подробное описание одним и тем же предложением, так как краткое описание будет первым абзацем подробного описания.

/ *!
    \class PreviewWindow
    \brief The PreviewWindow class is a custom widget
           displaying the names of its currently set
           window flags in a read-only text editor.

    The PreviewWindow class inherits QWidget. The widget
    displays the names of its window flags set with the
    setWindowFlags() function. It is also provided with a
    QPushButton that closes the window.

    ...

    \sa QWidget
* /

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

PreviewWindow Справочная информация по классу

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

Свойства

• 52 свойства унаследованы от QWidget
• 1 свойство унаследовано от QObject

Общедоступные функции

• PreviewWindow(QWidget *parent = 0)
• void setWindowFlags(Qt::WindowFlags flags)

• 183 общедоступные функции унаследованы от QWidget
• 28 общедоступных функций унаследовано от QObject

Общедоступные слоты

• 17 общедоступных слотов унаследовано от QWidget
• 1 общедоступный слот унаследован от QObject

Дополнительные унаследованные члены

• 1 сигнал унаследован от QWidget
• 1 сигнал унаследован от QObject
• 4 статических общедоступных члена унаследовано от QWidget
• 4 статических общедоступных члена унаследовано от QObject
• 39 защищенных функций унаследовано от QWidget
• 7 защищенных функций унаследовано от QObject

---

Подробное описание

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

Класс PreviewWindow наследует QWidget. Виджет отображает имена флагов окна, установленных с помощью функции setWindowFlags(). Также он оснащен кнопкой QPushButton, которая закрывает окно.

...

См. также QWidget.

---

Документация по функциям-членам

PreviewWindow(QWidget *parent = 0)

Создает виджет окна предварительного просмотра с parent.

setWindowFlags(Qt::WindowFlags flags)

Устанавливает флаги виджета с помощью функции QWidget::setWindowFlags().

Затем перебирает доступные флаги окна, создавая текст, содержащий имена флагов, соответствующих параметру flags, отображая текст в текстовом редакторе виджета.

Использование \brief в \namespace:

/ *!
    \namespace Qt

    \brief The Qt namespace contains miscellaneous identifiers
    used throughout the Qt library.
* /

Использование \brief в \headerfile:

/ *!
    \headerfile <QtGlobal>
    \title Global Qt Declarations

    \brief The <QtGlobal> header file provides basic
    declarations and is included by all other Qt headers.

    \sa <QtAlgorithms>
* /

См. также \property, \class, \namespace и \headerfile.

\legalese

Команды \legalese и \endlegalese задают лицензионное соглашение.

В сгенерированном HTML текст, ограниченный этими командами, окружен тегами <div class="LegaleseLeft"> и </div>.

Пример лицензионного соглашения, заключенного в \legalese и \endlegalese:

/ *!
  \legalese
      Copyright 1996 Daniel Dardailler.

      Permission to use, copy, modify, distribute, and sell this
      software for any purpose is hereby granted without fee,
      provided that the above copyright notice appear in all
      copies and that both that copyright notice and this
      permission notice appear in supporting documentation, and
      that the name of Daniel Dardailler not be used in
      advertising or publicity pertaining to distribution of the
      software without specific, written prior permission. Daniel
      Dardailler makes no representations about the suitability of
      this software for any purpose. It is provided "as is"
      without express or implied warranty.

  Modifications Copyright 1999 Matt Koss, under the same
      license as above.
      \endlegalese
    * /

Он будет отображаться в сгенерированном HTML как:

<div class="LegaleseLeft">
  <p>Copyright 1996 Daniel Dardailler.</p>
      <p>Permission to use, copy, modify, distribute, and sell
      this software for any purpose is hereby granted without fee,
      provided that the above copyright notice appear in all
      copies and that both that copyright notice and this
      permission notice appear in supporting documentation, and
      that the name of Daniel Dardailler not be used in
      advertising or publicity pertaining to distribution of the
      software without specific, written prior permission. Daniel
      Dardailler makes no representations about the suitability of
      this software for any purpose. It is provided "as is"
      without express or implied warranty.</p>

  <p>Modifications Copyright 1999 Matt Koss, under the same
      license as above.</p>
</div>

Если команда \endlegalese опущена, QDoc обработает команду \legalese, но рассматривает остальную часть страницы документации как лицензионное соглашение.

В идеале текст лицензии находится в лицензируемом коде.

В других случаях документация, идентифицированная командой \legalese, может быть собрана с помощью \generatelist с legalese в качестве аргумента. Это полезно для создания обзора лицензионных соглашений, связанных с исходным кодом.

Примечание: Вывод команды \generatelist legalese включает только тексты \legalese в текущем проекте документации. Если текущий проект документации зависит от других модулей, их тексты лицензий не будут перечислены.

\warning

Команда \warning добавляет «Предупреждение:» к аргументу команды жирным шрифтом.

/ *!
    Qt::HANDLE is a platform-specific handle type
    for system objects. This is  equivalent to
    \c{void *} on Windows and macOS, and to
    \c{unsigned long} on X11.

    \warning Using this type is not portable.
* /

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

Qt::HANDLE — это платформа-зависимый тип дескриптора для системных объектов. Это эквивалентно void * в Windows и macOS, и unsigned long в X11.

Предупреждение: Использование этого типа не является переносимым.