このページでは

テキストのマークアップ

テキストフォーマットコマンドは、テキストがどのように表示されるかを示す。

\a (パラメータマーカー)

\a コマンドは次の単語が正式なパラメータ名であることをQDocに伝えます。

形式パラメータが文書化されていなかったり、スペルミスがあったりすると警告が出ますので、関数を文書化する際には、\a コマンドの前に、関数の説明文の中で各形式パラメータ名を記述する必要があります。パラメータ名はイタリック体で表示されます。

形式パラメータ名は中括弧で囲んでもかまいませんが、これは必須ではありません。

\c (コードフォント)

\c コマンドは、変数名、ユーザー定義クラス名、および C++ キーワード(たとえば、intfor )をコード・フォントで表示するために使用します。

こ の コ マ ン ド は引数を等幅フ ォ ン ト で表示 し ます。コ ー ド フ ォ ン ト で表示す る テ キ ス ト に空白が含まれてい る 場合は、 テ キ ス ト 全体を中括弧で囲みます:

\c {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) : QWidget(parent)}

\c コマンドは、引数内の特殊文字\ を受け付けますが、これは通常の文字としてレンダリングされます。そのため、ネストされたコマンドを使いたい場合は、代わりにテレタイプ (\tt) コマンドを使う必要があります。

また \ttおよび \code.

\details (折りたたみ可能)

\details\enddetails コマンドは、<summary>を持つ折りたたみ可能な<details>要素を生成し、非表示/表示状態を制御します。

HTML出力を生成する場合は、\details\enddetails コマンドを使って、折りたたみ可能な<details> HTML要素を生成する。このコマンドは、中かっこで囲まれたオプションの要約文字列を取ります。このオプションの引数は、詳細の可視見出しを指定します。

例えば、次のように入力します:

/*!
    \details {QDoc details}
      \note You're looking at detailed information.
    \enddetails
*/

QDocがHTMLを生成する場合、これらのコマンドは次のように変換されます:

<summary>QDoc details</summary><div class="admonition note"><p><b>Note: </b>You're looking at detailed information.</p></div>

QDocはこれを次のようにレンダリングする:

QDocの詳細

注: 詳細情報を見ている。

それ以外の出力形式では、QDocは要約文字列を無視して通常の段落として内容を生成します。このコマンドはQt6.6でQDocに導入されました。

\div

\div\enddiv コマンドは、特別なフォーマット属性を適用すべきテキストの大小のブロック(他のQDocコマンドを含むかもしれない)を区切ります。

引数は、下に示すQDocコメントのように中かっこで指定しなければなりません。引数は解釈されませんが、QDocによって出力されるタグの属性として使われます。

例えば、インライン画像を現在のテキスト・ブロックの右側に浮くように表示したいとします:

/*!
    \div {class="float-right"}
        \inlineimage qml-column.png
    \enddiv
*/

QDocがHTMLを生成している場合、これらのコマンドは次のように変換されます:

<div class="float-right"><p><img src="images/qml-column.png" /></p></div>

HTMLの場合、属性値float-rightはstyle.cssファイルの節を参照します:

div.float-right
{
   float: right; margin-left: 2em
}

\divコマンドは入れ子にすることができます。

以下に、Qt 4.7のindex.htmlを生成するために使用したindex.qdocファイルの例を示します:

\div {class="indexbox guide"}
    \div {class="heading"}
        Qt Developer Guide
\enddiv
    \div {class="indexboxcont indexboxbar"}
        \div {class="section indexIcon"} \emptyspan
        \enddiv
        \div {class="section"}
            Qt is a cross-platform application and UI
            framework. Using Qt, you can write web-enabled
            applications once and deploy them across desktop,
            mobile and embedded operating systems without
            rewriting the source code.
        \enddiv
        \div {class="section sectionlist"}
            \list
               \li \l{Getting Started}
               \li \l{Installation} {Installation}
               \li \l{how-to-learn-qt.html} {How to learn Qt}
               \li \l{tutorials.html} {Tutorials}
               \li \l{Qt Examples} {Examples}
               \li \l{qt4-7-intro.html} {What's new in Qt 4.7}
            \endlist
        \enddiv
    \enddiv
\enddiv

Qt ドキュメントのレンダリングに使用される style.css ファイルで、すべての class 属性値が定義されている場合、上記の例は次のようにレンダリングされます:

Qt 開発者ガイド

Qt はクロスプラットフォームのアプリケーションと UI フレームワークです。Qt を使用することで、ソースコードを書き直すことなく、一度書いた Web アプリケーションをデスクトップ、モバイル、組み込みオペレーティングシステムにデプロイすることができます。

  • はじめに
  • インストール
  • Qt の学習方法
  • チュートリアル
  • サンプル
  • Qt 4.7 の新機能

こちらもご覧ください \span.

\span

\span コマンドは、小さなテキストブロックに特別な書式を適用します。

以下のQDocのコメントにあるように、2つの引数を与えなければならない。最初の引数は解釈されませんが、QDocが出力するタグの書式属性を指定します。番目の引数は特別なフォーマット属性でレンダリングされるテキストです。

例えば、数値リストの各要素の最初の単語を青で表示したいとします。

/*!
    Global variables with complex types:
\list 1
        \li \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
        \li \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
        \li \span {class="variableName"} {constComplex1} in globals.cpp at line 16
        \li \span {class="variableName"} {constComplex2} in globals.cpp at line 17
    \endlist
*/

classvariableNameは、style.cssの節を参照します。

.variableName
{
    font-family: courier;
color: blue
}

上で示したvariableName節を使用すると、例は次のようにレンダリングされます:

複雑な型を持つグローバル変数:

  1. globals.cpp の 14 行目にあるmutableComplex1
  2. globals.cpp の 15 行目にあるmutableComplex2
  3. 16 行目の globals.cpp のconstComplex1
  4. 17 行目の globals.cpp のconstComplex2

注釈 spanコマンドでは、新しい段落は開始されません。

以下も参照してください。 \div.

\tm 商標

\tm コマンドはその引数が商標であることを示します。QDocはページを生成するときに、その引数の最初の出現箇所に商標シンボル`™`を付加します。

プロジェクトの設定では、navigation.trademarkspage 変数は商標関連のドキュメントを含むページのタイトルを定義するために使われます。

navigation.trademarkspage = Trademarks

この変数がセットされている場合、商標シンボルの各出現も商標ページにリンクします。

注: セクションタイトルでは、\tm コマンドは無視され、引数はそのままレンダリングされます。

また \section1および navigation.

\tt (テレタイプフォント)

\tt コマンドは引数を等幅フォントで表示する。このコマンドは \cコマンドと同じように振る舞いますが、\tt 、引数の中にQDocコマンドを入れ子にすることができます(例えば \e, \b\underline).

/*!
    After having populated the main container with
    child widgets, \c setupUi() scans the main container's list of
    slots for names with the form
    \tt{on_\e{objectName}_\e{signalName}().}
*/

コードフォントでレンダリングするテキストにスペースが含まれている場合は、テキスト全体を中カッコで囲みます。

\tt {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)}

参照 \c.

\b

\b コマンドはその引数を太字で表示する。このコマンドは以前は\bold と呼ばれていた。

/*!
    This is regular text; \b {this text is
    rendered using the \\b command}.
*/

\br

\br コマンドは強制的に改行する。

\e (強調、イタリック)

\e コマンドは、引数を特別なフォント(通常はイタリック体)で表示する。このコマンドは以前は\i と呼ばれていたが、現在は非推奨である。

引数に空白やその他の句読点が含まれる場合は、引数を波括弧で囲む。

/*!
    Here, we render \e {a few words} in italics.
*/

スペースを含む引数の中で他のQDocコマンドを使いたい場合は、常に中括弧で囲む必要があります。しかしQDocは賢いので、このような場合には中括弧は必要ありません:

/*!
    An argument can sometimes contain whitespaces,
    for example: \e QPushButton(tr("A Brand New Button"))
*/

最後に、末尾の句読点は引数に含まれませんし、"'s "も含まれません。

\sub

\sub コマンドは、引数を通常のテキストのベースラインより低く表示し、小さいフォントを使用する。

/*!
    Definition (Range): Consider the sequence
    {x\sub n}\sub {n > 1} . The set

    {x\sub 2, x\sub 3, x\sub 4, ...} = {x\sub n ; n = 2, 3, 4, ...}

    is called the range of the sequence.
*/

引数に空白やその他の句読点が含まれる場合は、中かっこで囲む。

\sup

\sup コマンドは、引数を通常のテキストのベースラインより高く表示し、小さいフォントを使用する。

/*!
    The series

    1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...

    is called the \i {geometric series}.
*/

引数にスペースやその他の句読点が含まれる場合は、中かっこで囲む。

\uicontrol

\uicontrol コマンドは、コンテンツがUIコントロール要素に使用されていることを示すために使用されます。HTMLを使用する場合、出力は太字で表示されます。

以下も参照のこと。 \b.

\underline

\underline コマンドは引数に下線を引く。

/*!
    The \underline {F}ile menu gives the users the possibility
    to edit an existing file, or save a new or modified
    file, and exit the application.
*/

引数に空白やその他の句読点が含まれる場合は、中かっこで囲む。

\\ (ダブル・バックスラッシュ)

シーケンスは1つのバックスラッシュに展開される。

QDocコマンドは常に1つのバックスラッシュで始まります。テキストに1つのバックスラッシュを表示するには、2つのバックスラッシュを入力する必要があります。バックスラッシュを2つ表示したい場合は、4つ入力する必要があります。

/*!
    The \\\\ command is useful if you want a
    backslash to appear verbatim, for example,
    writing C:\\windows\\home\\.
*/

ただし、テキストを等幅フォントでも表示したい場合は、代わりに \cコマンドを使えば、バックスラッシュを他の文字と同じように受け入れて表示することができます。例えば

/*!
    The \\c command is useful if you want a
    backslash to appear verbatim, and the word
    that contains it written in a monospace font,
    like this: \c {C:\windows\home\}.
*/

-- ダッシュ

QDocはダブル・ハイフンをエン・ダッシュとして表示します。QDocのマークアップコマンドは入力をそのまま表示するように設計されているため、\c コマンドのようにダブル・ハイフンをエン・ダッシュに置き換えることはありません。例えば

/*!
    The \\c command -- useful if you want text in a monospace font --
    is well documented.
*/

しかし、他のコマンドではQDocが期待通りに出力をレンダリングするためにハイフンをエスケープする必要があるかもしれません。例えば

/*!
    This \l {endash-sequence}{link to the -- (endash) sequence}
    isn't escaped and QDoc therefore renders an endash in the link
    text. However, the escaped
    \l {endash-sequence}{link to the \-- (endash) sequence}
    renders both hyphens as intended.
*/

警告: 警告:セクションやページのタイトルにエン・ダッシュを使わないでください。タイトルにエンダッシュなどの特殊文字が含まれていると、リンクに失敗することがあります。

emダッシュも参照してください。

--- (emダッシュ)

QDocはトリプルハイフンをemダッシュとして表示します。QDocのマークアップコマンドは入力をそのまま表示するように設計されています-たとえば\c -トリプルハイフンをemダッシュに置き換えることはありません。例えば

/*!
    The \\c command---useful when you want text to be rendered
    verbatim---is well documented.
*/

しかし、他のコマンドではQDocが期待通りに出力をレンダリングするためにハイフンをエスケープする必要があるかもしれません。例えば

/*!
    This \l {emdash-sequence}{link to the --- (emdash) sequence}
    isn't escaped and QDoc therefore renders an emdash in the link
    text. However, the escaped
    \l {emdash-sequence}{link to the -\-- (emdash) sequence}
    renders both hyphens as intended.
*/

注意: この例でエスケープされているのはエン・ダッシュです。これにより、ハイフンの後にエン・ダッシュが出力されるのを防ぐことができます。

警告 セクションやページのタイトルにemダッシュを使わないでください。タイトルにemダッシュのような特殊文字が含まれていると、リンクに失敗することがあります。

また、--(エン・ダッシュ)も参照してください。

© 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.