特別コンテンツ
文書内容コマンドは、文書の一部、特別なレンダリング、概念的な意味や機能を持つ部分を識別します。
\quotation
\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
*/ブロック内のテキストは \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>タグの内容を左右にインデントして表示します。上の例は次のようにレンダリングされます：
私たちのソリューションが新しい環境に採用されるにつれ、より広範なエンタープライズ・アプリケーションとの統合を容易にしたいというニーズが高まってきました。
しかし、style.cssファイルで<blockquote>タグを再定義することができます。
\note
\note コマンドは、太字の "Note: "で始まる新しい段落を定義します。このコマンドは連続した段落を引数にとり、段落の終わりで終了します。noteコマンドは短い文章にのみ使え、長い複数行の段落には使えません。
コマンドと同様に \warningコマンドと同様に、note は短くて重要な文のためのものです。使い方についてはQt Writing Guidelinesを参照してください。
\notranslate
\notranslate コマンドは、生成された出力が言語翻訳サービスに渡される場合、引数が翻訳されないことを示します。
その他のコマンド (\c, \tt)も同じ効果を持つが、\notranslate はその引数にスタイルを指定しない。
このコマンドはQDocバージョン6.10で導入された。
\brief
\brief コマンドはトピックコマンドのいずれかの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(), ... */
\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
*/で\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コマンドは \generatelistlegalese を引数として指定します。これは、ソースコードに関連するライセンス契約の概要を生成するのに便利です。
注意: \generatelist legalese コマンドの出力には、現在のドキュメントプロジェクトの\legalese テキストのみが含まれます。現在のドキュメントプロジェクトが他のモジュールに依存している場合、それらのライセンステキストはリストされません。
\warning
\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.
*/© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
