テキストのマークアップ
テキスト書式コマンドは、テキストをどのように表示するかを示す。
\パラメータマーカー
(パラメータ・マーカー) \a コマンドは、次の単語が正式なパラメータ名であることを QDoc に伝えます。
このため、関数を文書化するときは、関数の説明の中で各フォーマルパラメー タの名前を挙げてから、その前に \a コマンドを記述する必要があります。パラメータ名はイタリック体で表示されます。
形式パラメータ名は中括弧で囲むことができますが、これは必須ではありません。
\c（コードフォント）
変数名、ユーザー定義クラス名、C++ キーワード（例えば、int やfor ）をコード・フォントで表示するために使用します。
このコマンドは、引数を等幅フォントで表示します。コード・フォントで表示するテキストにスペースが含まれている場合は、テキスト全体を中かっこで囲みます：
The \c command accepts the special character\ within its argument, which renders it as a normal character.そのため、ネストされたコマンドを使用したい場合は、代わりにテレタイプ( \tt)コマンドを使用する必要があります。
\詳細（折りたたみ可能）
detailsコマンドとenddetailsコマンドは、非表示/表示状態を制御するための<summary>を持つ折りたたみ可能な<details>要素を生成します。
HTML出力を生成する場合、折りたたみ可能な<details> HTML要素を生成するために、♪details♪コマンドと♪enddetails♪コマンドを使用します。このコマンドは、中括弧で囲まれたオプションの要約文字列を取ります。このオプションの引数は、詳細の可視見出しを指定します。
例えば、次のように入力します：
/*!
\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
このコマンドはQt6.6で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ファイルにあるように、すべてのクラス属性値が定義されている場合、上記の例は次のようにレンダリングされます：
Qt 開発者ガイド
こちらもご覧ください。
\を参照してください。
Ȃ Ȃ Ȃ Ȃ Ȃ Ȃ
以下の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節を使用すると、例は次のようにレンダリングされます：
複雑な型を持つグローバル変数：
- globals.cpp の 14 行目にあるmutableComplex1
- globals.cpp の 15 行目にあるmutableComplex2
- 16 行目の globals.cpp のconstComplex1
- 17 行目の globals.cpp のconstComplex2
注釈 spanコマンドでは、新しい段落は開始されません。
divも参照してください。
\tm
(商標) ゙tmコマンドはその引数が商標であることを示します。QDocはページを生成するとき、その引数の最初に商標シンボル`™`を追加します。
プロジェクトの設定では、navigation.trademarkspage 変数が商標関連のドキュメントを含むページのタイトルを定義するために使用されます。
navigation.trademarkspage = Trademarks
もしセットされていれば、商標シンボルが出現するたびに商標ページへのリンクも張られます。
注意: セクション・タイトルでは、"◆tm "コマンドは無視され、引数はそのままレンダリングされます。
を参照してください。 navigation.
\tt (テレタイプフォント)
このコマンドは、引数を等幅フォントで表示します。このコマンドの動作は、引数の中にQDocコマンドを入れ子にできる(例: ⊖e 、⊖b 、⊖underline)ことを除けば、⊖cコマンドと同じです。
/*!
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}().}
*/コードフォントでレンダリングするテキストにスペースが含まれている場合は、テキスト全体を中括弧で囲みます。
参照。
\b
bコマンドは引数を太字で表示します。このコマンドは、以前は、˶boldと呼ばれていました。
/*!
This is regular text; \b {this text is
rendered using the \\b command}.
*/\br
を強制的に改行します。
\e（強調、斜体）
このコマンドは、以前は「itui」と呼ばれていましたが、現在は非推奨です。このコマンドは、以前は「◎◎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 "も含まれません。
\サブ
"s "も引数に含まれません。
/*!
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.
*/引数にスペースやその他の句読点が含まれる場合は、引数を中かっこで囲みます。
\upコマンド
引数を通常のテキストのベースラインより高く、小さいフォントで表示します。
/*!
The series
1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...
is called the \i {geometric series}.
*/引数に空白やその他の句読点が含まれる場合は、引数を中かっこで囲む。
\uicontrol
UI制御要素に使用されるコンテンツとしてマークを付けるには、 ︙uicontrolコマンドを使用します。HTMLを使用する場合、出力は太字で表示されます。
を参照してください。
\アンダーライン
引数に下線を引く。
/*!
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はダブル・ハイフンをエン・ダッシュに置き換えません。例えば
/*!
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はトリプルハイフンをenダッシュとして表示します。QDocはトリプル・ハイフンをエン・ダッシュに置き換えません。例えば
/*!
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.
*/注意： この例でエスケープされているのはエン・ダッシュです。これにより、ハイフンの後にエン・ダッシュが出力されるのを防ぐことができます。
en dash）も参照のこと。
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 ここで提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
