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

@attention【注意】

メモ

概要

注意メッセージを記述
- 隣接する複数の @attention【注意】コマンドは１つの段落に結合
- 空行・他のセクションコマンドで終了
マークダウン (Markdown) の [!CAUTION]【アラート：注意】は、このコマンドに変換 ^1.11.0

外部リンク

Doxygen Special Commands (英語)： \attention

構文

@attention 注意メッセージ

例

/// @attention 注意メッセージＡ
/// @attention 注意メッセージＢ
/// @attention 注意メッセージＣ１
///            注意メッセージＣ２
///            注意メッセージＣ３

【HTML出力例：ライトモード】

注意: 注意メッセージＡ; 注意メッセージＢ; 注意メッセージＣ１注意メッセージＣ２注意メッセージＣ３

【HTML出力例：ダークモード】

注意: 注意メッセージＡ; 注意メッセージＢ; 注意メッセージＣ１注意メッセージＣ２注意メッセージＣ３

【マークダウン：アラート】

/// > [!CAUTION]
/// > 注意メッセージＤ
///
/// > [!CAUTION]
/// > 注意メッセージＥ
///
/// > [!CAUTION]
/// > 注意メッセージＦ１
/// > 注意メッセージＦ２

【HTML出力例】

注意: 注意メッセージＤ; 注意メッセージＥ; 注意メッセージＦ１注意メッセージＦ２

@important【重要】^1.11.0

メモ

概要

重要メッセージを記述
- 隣接する複数の @important【重要】コマンドは１つの段落に結合
- 空行・他のセクションコマンドで終了
マークダウン (Markdown) の [!IMPORTANT]【アラート：重要】は、このコマンドに変換

外部リンク

Doxygen Special Commands (英語)： \warning

構文

@important 重要メッセージ ^1.11.0

例

/// @important 警告メッセージＡ
/// @important 重要告メッセージＢ
/// @important 重要メッセージＣ１
///          重要メッセージＣ２
///          重要メッセージＣ３

【HTML出力例：ライトモード】

Important: 重要メッセージＡ; 重要メッセージＢ; 重要メッセージＣ１重要メッセージＣ２重要メッセージＣ３

【HTML出力例：ダークモード】

Important: 重要メッセージＡ; 重要メッセージＢ; 重要メッセージＣ１重要メッセージＣ２重要メッセージＣ３

【マークダウン：アラート】

/// > [!IMPORTANT]
/// > 重要メッセージＤ
///
/// > [!IMPORTANT]
/// > 重要メッセージＥ
///
/// > [!IMPORTANT]
/// > 重要メッセージＦ１
/// > 重要メッセージＦ２

【HTML出力例】

Important: 重要メッセージＤ; 重要メッセージＥ; 重要メッセージＦ１重要メッセージＦ２

@warning【警告】

メモ

概要

警告メッセージを記述
- 隣接する複数の @warning【警告】コマンドは１つの段落に結合
- 空行・他のセクションコマンドで終了
マークダウン (Markdown) の [!WARNING]【アラート：警告】は、このコマンドに変換 ^1.11.0

外部リンク

Doxygen Special Commands (英語)： \warning

構文

@warning 警告メッセージ

例

/// @warning 警告メッセージＡ
/// @warning 警告メッセージＢ
/// @warning 警告メッセージＣ１
///          警告メッセージＣ２
///          警告メッセージＣ３

【HTML出力例：ライトモード】

警告: 警告メッセージＡ; 警告メッセージＢ; 警告メッセージＣ１警告メッセージＣ２警告メッセージＣ３

【HTML出力例：ダークモード】

警告: 警告メッセージＡ; 警告メッセージＢ; 警告メッセージＣ１警告メッセージＣ２警告メッセージＣ３

【マークダウン：アラート】

/// > [!WARNING]
/// > 警告メッセージＤ
///
/// > [!WARNING]
/// > 警告メッセージＥ
///
/// > [!WARNING]
/// > 警告メッセージＦ１
/// > 警告メッセージＦ２

【HTML出力例】

警告: 警告メッセージＤ; 警告メッセージＥ; 警告メッセージＦ１警告メッセージＦ２

@bug【バグ (一覧)】

メモ

概要

バグの説明を記述
- 隣接する複数の @bug【バグ (一覧)】コマンドは１つの段落に結合
- 空行・他のセクションコマンドで終了
- 全体の一覧にも出力可能 (デフォルト：出力あり)
  出力有無：GENERATE_BUGLIST【@bug の一覧出力有無】

外部リンク

Doxygen Special Commands (英語)： \bug

構文

@bug バグの説明

例

/// @bug バグの説明Ａ
/// @bug バグの説明Ｂ
/// @bug バグの説明Ｃ１
///      バグの説明Ｃ２
///      バグの説明Ｃ３

【HTML出力例：ライトモード】

バグ

バグの説明Ａ

バグの説明Ｂ

バグの説明Ｃ１バグの説明Ｃ２バグの説明Ｃ３

【HTML出力例：ダークモード】

バグ

バグの説明Ａ

バグの説明Ｂ

バグの説明Ｃ１バグの説明Ｃ２バグの説明Ｃ３

@deprecated【非推奨 (一覧)】

メモ

概要

非推奨の説明を記述
- 隣接する複数の @deprecated【非推奨 (一覧)】コマンドは１つの段落に結合
- 空行・他のセクションコマンドで終了
- 全体の一覧にも出力可能 (デフォルト：出力あり)
  出力有無：GENERATE_DEPRECATEDLIST【@deprecated の一覧出力有無】

外部リンク

Doxygen Special Commands (英語)： \deprecated

構文

@deprecated 非推奨の説明

例

/// @deprecated 非推奨の説明Ａ
/// @deprecated 非推奨の説明Ｂ
/// @deprecated 非推奨の説明Ｃ１
///             非推奨の説明Ｃ２
///             非推奨の説明Ｃ３

【HTML出力例：ライトモード】

非推奨

非推奨の説明Ａ

非推奨の説明Ｂ

非推奨の説明Ｃ１の説明Ｃ２非推奨の説明Ｃ３

【HTML出力例：ダークモード】

非推奨

非推奨の説明Ａ

非推奨の説明Ｂ

非推奨の説明Ｃ１の説明Ｃ２非推奨の説明Ｃ３

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

メモ

概要

テストケースを記述
- 隣接する複数の @test【テストケース (一覧)】コマンドは１つの段落に結合
- 空行・他のセクションコマンドで終了
- 全体の一覧にも出力可能 (デフォルト：出力あり)
  出力有無：GENERATE_TESTLIST【@test の一覧出力有無】

外部リンク

Doxygen Special Commands (英語)： \test

構文

@test テストケース

例

/// @test テストケースＡ
/// @test テストケースＢ
/// @test テストケースＣ１
///       テストケースＣ２
///       テストケースＣ３

【HTML出力例：ライトモード】

テスト

テストケースＡ

テストケースＢ

テストケースＣ１テストケースＣ２テストケースＣ３

【HTML出力例：ダークモード】

テスト

テストケースＡ

テストケースＢ

テストケースＣ１テストケースＣ２テストケースＣ３

@todo【TODO (一覧)】

メモ

概要

TODOを記述
- 隣接する複数の @todo【TODO (一覧)】コマンドは１つの段落に結合
- 空行・他のセクションコマンドで終了
- 全体の一覧にも出力可能 (デフォルト：出力あり)
  出力有無：GENERATE_TODOLIST【@todo の一覧出力有無】

外部リンク

Doxygen Special Commands (英語)： \todo

構文

@todo TODO

例

/// @todo TODO-Ａ
/// @todo TODO-Ｂ
/// @todo TODO-Ｃ１
///       TODO-Ｃ２
///       TODO-Ｃ３

【HTML出力例：ライトモード】

todo

TODO-Ａ

TODO-Ｂ

TODO-Ｃ１ TODO-Ｃ２ TODO-Ｃ３

【HTML出力例：ダークモード】

todo

TODO-Ａ

TODO-Ｂ

TODO-Ｃ１ TODO-Ｃ２ TODO-Ｃ３

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

メモ

概要

ユーザ定義を記述
- 隣接する複数のユニークキーが同一の@xrefitem【ユーザ定義 (一覧)】コマンドは１つの段落に結合
- 空行・他のセクションコマンドで終了
- 下記の一覧出力系関連コマンドと同様に、全体の一覧にも出力 (変更履歴・バグフィックス等に有用) 〔例〕
- 全体の一覧には出力させない場合、@par【ユーザ定義 (段落)】を使用

使用方法

通常、ALIASES【エイリアス】を指定して、ユーザ定義コマンド(別名)を使用 (構文参照)
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; /* 出力する縦線の色 */
}
```

外部リンク

Doxygen Special Commands (英語)： \xrefitem

構文

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

ユニークキー：プロジェクト内で一意となるキー
段落タイトル：段落のタイトル (同一の場合、１つの段落に結合)
一覧タイトル：一覧のタイトル (同一の場合、１つの一覧に結合)
ユーザ定義の説明：ユーザが定めた任意の説明

上記を ALIASES【エイリアス】を指定して簡略化

【エイリアス指定】
ユーザ定義コマンド=@xrefitem ユニークキー "段落タイトル" "一覧タイトル"

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

@ユーザ定義コマンド ユーザ定義の説明

ユーザ定義の説明：ユーザが定めた任意の説明

例

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 変更２Ａ
/// @v2_0_0 変更２Ｂ
/// @v2_0_0 変更２Ｃ１
///         変更２Ｃ２
///         変更２Ｃ３
/// @v3_0_0 変更３Ａ
/// @v3_0_0 変更３Ｂ
/// @v3_0_0 変更３Ｃ１
///         変更３Ｃ２
///         変更３Ｃ３

【HTML出力例】

変更履歴 (v2.0.0):

変更２Ａ

変更２Ｂ

変更２Ｃ１変更２Ｃ２変更２Ｃ３

変更履歴 (v3.0.0):

変更３Ａ

変更３Ｂ

変更３Ｃ１変更３Ｃ２変更３Ｃ３

省略 ^1.8.14	Ver. 1.8.14 対応
^x.y.z ^x.y.z	Ver. x.y.z 対応
^x.y.z ^x.y.z	Ver. x.y.z で廃止
	単一の単語
	行末までが対象
	次の段落までが対象
構文：[～]	～は省略可能
構文：[～]	[と] はそのまま記述
構文：x\|y	x または y
構文： \|	\| はそのまま記述
	半角スペース
	Graphviz を使用
	Mscgen を使用
	PlantUML を使用
	Dia を使用
Link	別リファレンスリンク
Link	外部リンク

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