行の始まりに、カラム位置の揃ったマイナス記号をいくつか並べることによって、黒丸付きリストが自動的に生成されます。マイナス記号の後にハッシュ (#) を置くことにより、数字付きリストを生成することもできます。リストのネスティングも可能です。

例:

  /*! 
   *  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
   *         -# key down event
   *         -# 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 が適切なタブサイズに設定されているか、確認してください。

HTML コマンドを使う

お好みとあらば、ドキュメントブロック内で HTML コマンドを使うこともできます。これらのコマンドを使用することの利点は、それが、複数のパラグラフからなるリスト項目においてはより自然だということです。

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

  /*! 
   *  A list of events:
   *  <ul>
   *  <li> mouse events
   *     <ol>
   *     <li>mouse move event
   *     <li>mouse click event\n
   *         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 を使う

Troll Tech社内部のドキュメンテーションツールおよび KDoc との互換性のために、 doxygen には、単純でネストしないリストを作成するのに使用できる、 2つのコマンドがあります。

詳しくは、\arg および \li を参照してください。

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

Doxygen manualに対してTue Oct 16 12:04:38 2001に生成されました。