Q&A:Doxygenで変更履歴一覧を作成するには?

Q:Doxygenで変更履歴一覧を作成するには?

A:@xrefitem【ユーザ定義 (一覧)】とALIASES【エイリアス】を使用する。

(関連 – Q&A:Doxygenで独自コマンドを定義するには?)


詳細

設定オプションのALIASES【エイリアス】に、@xrefitem【ユーザ定義 (一覧)】の別名として、変更履歴一覧に対応したコマンドを定義する。
例として、ver 1.1 と ver 2.0 の変更を履歴一覧とする場合、下記の様に ver_1_1ver_2_0 を定義する。

ver_1_1=@xrefitem ver_1_1 "ver 1.1" "ver 1.1 (2001/02/03)"
ver_2_0=@xrefitem ver_2_0 "ver 2.0" "ver 2.0 (2004/05/06)"

(ALIASES【エイリアス】:Doxygen GUIでは[Expert]タブ – [Topics-Project] – [ALIASES] )

該当する変更箇所に、定義した @ver_1_1@ver_2_0 を下記例の様に記述する。

/// 関数の説明
/// @ver_1_1 バグnnnn対応
/// @ver_2_0 パフォーマンス対応

void funcA() {
  // ・・・
}

/// 関数の説明
/// @ver_2_0 新規作成

void funcB() {
  // ・・・
}


詳細な仕様は、親サイトの@xrefitem【ユーザ定義 (一覧)】ALIASES【エイリアス】 を参照


HTMLの出力例

ナビ部

ver 1.1 一覧

ver 2.0 一覧

関数詳細