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.14.0
