@attention【注意】
@warning【警告】
@bug【バグ (一覧)】
@deprecated【非推奨 (一覧)】
@test【テストケース (一覧)】
@todo【TODO (一覧)】
@xrefitem【ユーザ定義 (一覧)】

@attention【注意】

メモ

構文

@attention 注意メッセージ

/// @attention 注意メッセージA
/// @attention 注意メッセージB
/// @attention 注意メッセージC1
///            注意メッセージC2
///            注意メッセージC3

【HTML出力例】

注意
注意メッセージA
注意メッセージB
注意メッセージC1 注意メッセージC2 注意メッセージC3

@warning【警告】

メモ

構文

@warning 警告メッセージ

/// @warning 警告メッセージA
/// @warning 警告メッセージB
/// @warning 警告メッセージC1
///          警告メッセージC2
///          警告メッセージC3

【HTML出力例】

警告
警告メッセージA
警告メッセージB
警告メッセージC1 警告メッセージC2 警告メッセージC3

@bug【バグ (一覧)】

メモ

構文

@bug バグの説明

/// @bug バグの説明A
/// @bug バグの説明B
/// @bug バグの説明C1
///      バグの説明C2
///      バグの説明C3

【HTML出力例】

バグ:

バグの説明A

バグの説明B

バグの説明C1 バグの説明C2 バグの説明C3


@deprecated【非推奨 (一覧)】

メモ

構文

@deprecated 非推奨の説明

/// @deprecated 非推奨の説明

【HTML出力例】

非推奨:
非推奨の説明

@test【テストケース (一覧)】

メモ

構文

@test テストケース

/// @test テストケースA
/// @test テストケースB
/// @test テストケースC1
///       テストケースC2
///       テストケースC3

【HTML出力例】

テスト:

テストケースA

テストケースB

テストケースC1 テストケースC2 テストケースC3


@todo【TODO (一覧)】

メモ

構文

@todo TODO

/// @todo TODO-A
/// @todo TODO-B
/// @todo TODO-C1
///       TODO-C2
///       TODO-C3

【HTML出力例】

todo:

TODO-A

TODO-B

TODO-C1 TODO-C2 TODO-C3


@xrefitem【ユーザ定義 (一覧)】

メモ

  • ユーザ定義を記述
    • 隣接する複数の ユニークキーが同一の@xrefitem【ユーザ定義 (一覧)】コマンドは1つの段落に結合
    • 空行・他のセクションコマンドで終了
    • 下記の関連コマンドと同様に、全体の一覧にも出力 (変更履歴等に有用)
    • 全体の一覧には出力させない場合、@par【段落 (ユーザ定義)】を使用
  • 使用方法
    • 通常、エイリアスを指定して使用 (例も参照)
      Doxygen GUI の [Expert]タブ - [Topics-Project] - [ALIASES] に下記を追加
      【エイリアス名】=@xrefitem 【ユニークキー】 "【段落タイトル】" "【一覧タイトル】"
      エイリアスを使用して下記を記述
      @【エイリアス名】 【ユーザ定義の説明】
    • HTML出力で@todo【TODO (一覧)】等の様に左側に縦線を入れる場合、doxygen.css の dl.todo を参考に css ファイルを作成し、 ファイルを HTML_EXTRA_STYLESHEET【ユーザー定義の追加CSS】 に追加
      dl.【エイリアス指定のユニークキー】 {
        margin-left: -7px;
        padding-left: 3px;
        border-left: 4px solid;
        border-color: #00C0E0; /* 出力する縦線の色 */
      }
      
  • 関連

構文

@xrefitem ユニークキー "段落タイトル" "一覧タイトル" ユーザ定義の説明

ユニークキー:プロジェクト内で一意となるキー
段落タイトル:段落のタイトル (同一の場合、1つの段落に結合)
一覧タイトル:一覧のタイトル (同一の場合、1つの一覧に結合)

ALIASES【エイリアス】
v2_0_0=@xrefitem v200 "変更履歴 (v2.0.0)" "変更履歴一覧 (v2.0.0 2001/02/03)"
v3_0_0=@xrefitem v300 "変更履歴 (v3.0.0)" "変更履歴一覧 (v3.0.0 2004/05/06)"

/// @v2_0_0 変更2A
/// @v2_0_0 変更2B
/// @v2_0_0 変更2C1
///         変更2C2
///         変更2C3
/// @v3_0_0 変更3A
/// @v3_0_0 変更3B
/// @v3_0_0 変更3C1
///         変更3C2
///         変更3C3

【HTML出力例】

変更履歴 (v2.0.0):

変更2A

変更2B

変更2C1 変更2C2 変更2C3

変更履歴 (v3.0.0):

変更3A

変更3B

変更3C1 変更3C2 変更3C3