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

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

\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 представляет однопредложное описание класса, пространства имен, заголовочного файла, свойства или переменной.

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

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

Когда команда \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.

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