リスト

doxygen は、項目のリストを作成する多くの方法を提供しています。

ダッシュを使う

行の始まりに、カラム位置の揃ったマイナス記号をいくつか並べることによって、黒丸付きリストが自動的に生成されます。 マイナス記号の代わりに、プラス(+)やアスタリスク(*)も使えます。

数字付きリストは、マイナス記号に続いてハッシュを書くか、数字に続いてドットを書くことで、生成できます。

項目の字下げに基づくリストの入れ子も可能です。

例を示します。

  /*! 
   *  A list of events:
   *    - mouse events
   *         -# mouse move event
   *         -# mouse click event\n
   *            More info about the click event.
   *         -# mouse double click event
   *    - keyboard events
   *         1. key down event
   *         2. key up event
   *
   *  More text here.
   */

結果は次のようになります:

A list of events:

• mouse events
  1. mouse move event
  2. mouse click event
     More info about the click event.
  3. mouse double click event
• keyboard events
  1. key down event
  2. key up event

More text here.

リスト内の字下げのためにタブを使う場合、設定ファイルの TAB_SIZE が正しいタブサイズに設定されていることを確かめてください。

新しいパラグラフを始めるか、または終えたいリストと同じ字下げレベルでドット (.) を空のラインに置くことによってリストを終えることができます。

以下は、その例です。

/**
 * リストの前のテキスト
 * - list item 1
 *   - sub item 1
 *     - sub sub item 1
 *     - sub sub item 2
 *     . 
 *     上の.は sub sub item list を終了します。
 *
 *     最初の sub item に対するテキスト
 *   .
 *   上の.は最初の sub item を終了します。
 *
 *   最初の list item に対するテキスト
 *   - sub item 2
 *   - sub item 3
 * - list item 2
 * .
 * 同じパラグラフのテキスト
 *
 * 新しいパラグラフのテキスト
 */

HTML コマンドを使う

お好みとあらば、ドキュメントブロック内で HTML コマンドを使うこともできます。

以下は、上の例の HTML コマンド版です:

  /*! 
   *  A list of events:
   *  <ul>
   *  <li> mouse events
   *     <ol>
   *     <li>mouse move event
   *     <li>mouse click event<br>
   *         More info about the click event.
   *     <li>mouse double click event
   *     </ol>
   *  <li> keyboard events
   *     <ol>     
   *     <li>key down event
   *     <li>key up event
   *     </ol>
   *  </ul>
   *  More text here.
   */

覚え書き

この場合の字下げは重要ではありません。

\arg または \li を使う

Qt Softwareの内部ドキュメンテーションツールqdocおよび KDoc との互換性のために、 doxygen には、2つのコマンドがあり、単純でネストされていないリストを作成するのに使用できます。 詳しくは、\arg および \li を参照してください。

次 のセクションに行く / インデックス に戻る