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. */
結果は次のようになります
イベントリスト
ここにさらにテキスト。
リスト内でインデントにタブを使用する場合は、設定ファイルの 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つのコマンドがあります。
1.13.0 によって生成されました
