特別コンテンツ

文書内容コマンドは、文書の一部、特別なレンダリング、概念的な意味や機能を持つ部分を識別します。

\引用

quotationとendquotationコマンドは、長い引用を区切ります。

区切られたブロック内のテキストは、html出力では<blockquote>と </blockquote>で囲まれます：

/*!
  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
*/

例えば、以下のようになります：

<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>タグの内容を左右にインデントして表示します。上の例は次のようにレンダリングされます：

私たちのソリューションが新しい環境に採用されるにつれ、より広範なエンタープライズ・アプリケーションとの統合を容易にしたいというニーズが高まってきました。

しかし、style.cssファイルで<blockquote>タグを再定義することができます。

\脚注

脚注を区切るコマンドです。

脚注はページの一番下に表示されます。

警告警告: ｟footnote｠と｠endfootnote｠コマンドは実装されていません。脚注は通常のHTML段落としてレンダリングされます。

\脚注

Note: "が太字で先行する新しい段落を定義します。

\目次

QDocが目次を自動的に生成するようになったため、♪tableofcontentsコマンドは使用できなくなりました。

自動生成された目次はページの右上に表示されます。

\概要

トピックコマンドのいずれかを1文で説明します。

この簡潔なテキストは、関連するオブジェクトのドキュメンテーションを紹介するときや、 ˶generatelistコマンドや˶annotatedlistコマンドで生成されるリストで使用されます。

この短いテキストは、その特定のトピックのドキュメントに表示されます。

例えば、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(), ...
*/

を使用してクラスを説明する場合は、次のような完全な文章を使用することをお勧めします：

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
*/

を使用します：

/*!
   \namespace Qt

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

を使用する：

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

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

   \sa <QtAlgorithms>
*/

を使用してください。

\を参照してください。

legaleseコマンドとendlegaleseコマンドは、ライセンス契約を区切ります。

生成されたHTMLでは、区切られたテキストは<div class="LegaleseLeft">と </div>タグで囲まれます。

legalese "と "legalese-end "で囲まれた使用許諾契約書の例：

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

を省略した場合、QDocは "endlegalese "コマンドを処理しますが、ドキュメントページの残りの部分を使用許諾契約書とみなします。

理想的には、ライセンステキストはライセンスされたコードと一緒に配置されます。

それ以外の場所では、legalese を引数として ˶generatelist を使用することで、˶ generatelistコマンドとして識別されたドキュメンテーションを蓄積することができます。これは、ソースコードに関連するライセンス契約の概要を生成するのに便利です。

注意: \generatelist legalese コマンドの出力には、現在のドキュメンテーション・プロジェクトに含まれるlegaleseテキストのみが含まれます。現在のドキュメント・プロジェクトが他のモジュールに依存している場合、それらのライセンス・テキストはリストされません。

\警告

注意: 現在のドキュメント・プロジェクトが他のモジュールに依存している場合、それらのライセンス・テキストはリストされません。

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

表とリストその他

本書に含まれる文書の著作権は、各所有者に帰属します。本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の商標です。その他すべての商標は、それぞれの所有者に帰属します。