Doxygen では、項目リストを作成するためのさまざまな方法が提供されています。

ダッシュの使用

行頭に複数個の縦に揃ったマイナス (-) 記号を置くと、箇条書きリストが自動的に生成されます。マイナス記号の代わりにプラス (+) またはアスタリスク (*) も使用できます。

番号付きリストは、マイナス記号の後にハッシュ (#) を付けるか、数字の後にドットを付けることで生成することもできます。

チェック済みまたは未チェックのチェックボックスをインジケータとするリストは、マイナスの後にオプションの空白を置き、その後に未チェックのチェックボックスには [ ]、チェック済みのチェックボックスには [x] または [X] を置くことで可能です。

リストのネストは可能であり、項目のインデントに基づいています。

例を次に示します

  /*! 
   *  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
   *    - checkbox list
   *         - [ ] unchecked
   *         - [x] checked
   *
   *  More text here.
   */

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

イベントのリスト

マウスイベント
1. マウス移動イベント
2. マウスクリックイベント
  クリックイベントに関する詳細情報。
3. マウスダブルクリックイベント
キーボードイベント
1. キーダウンイベント
2. キーアップイベント
チェックボックスリスト
- 未チェック
- チェック済み

ここにさらにテキスト。

リスト内でインデントにタブを使用する場合、設定ファイルの TAB_SIZE が正しいタブサイズに設定されていることを確認してください。

リストは、新しい段落を開始するか、終了したいリストと同じインデントレベルの空行にドット (.) を置くことで終了できます。

ここでは自明な例を示します

/**
 * Text before the list
 * - list item 1
 *   - sub item 1
 *     - sub sub item 1
 *     - sub sub item 2
 *     . 
 *     The dot above ends the sub sub item list.
 *
 *     More text for the first sub item
 *   .
 *   The dot above ends the first sub item.
 *
 *   More text for the first list item
 *   - sub item 2
 *   - sub item 3
 * - list item 2
 * .
 * More text in the same paragraph.
 *
 * More text in a new paragraph.
 */

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 を参照してください。

次のセクションに進むか、インデックスに戻ります。