Q&A:Doxygenで独自コマンドを定義するには?
Q:Doxygenで独自コマンドを定義するには?
A:@xrefitem【ユーザ定義 (一覧)】・@par【ユーザ定義 (段落)】とALIASES【エイリアス】を使用する。
詳細
一覧形式の場合は、詳細 (一覧形式) へ
段落形式の場合は、詳細 (段落形式) へ
詳細 (一覧形式)
一覧形式のコマンドを定義するには、@xrefitem【ユーザ定義 (一覧)】とALIASES【エイリアス】を使用する。
使用方法については、『Q&A:Doxygenで変更履歴一覧を作成するには?』を参照
一覧形式のコマンドは下記等が存在 (リンクは親サイト)
詳細な仕様は、親サイトの@xrefitem【ユーザ定義 (一覧)】・ALIASES【エイリアス】 を参照
詳細 (段落形式)
段落形式のコマンドを定義するには、@par【ユーザ定義 (段落)】とALIASES【エイリアス】を使用する。
設定オプションのALIASES【エイリアス】に、@par【ユーザ定義 (段落)】の別名として、独自コマンドを定義する。
例として、変更履歴 (段落) を作成する場合、下記の様に _history
を定義する。
_history=@par "変更履歴"
(ALIASES【エイリアス】:Doxygen GUIでは[Expert]タブ – [Topics-Project] – [ALIASES] )
該当する変更箇所に、定義した @_history
を下記例の様に記述する。
(改行については親サイトの、@n【改行】・@parblock・@endparblock【段落ブロック】を参照)
/// 関数の説明
/// @_history 変更履歴1
/// @_history 変更履歴2
/// 変更履歴3@n
/// 変更履歴4@n
/// 変更履歴5
/// @_history 変更履歴6
/// @_history
/// @parblock
/// 変更履歴11
/// 変更履歴12@n
/// 変更履歴13@n
/// 変更履歴14
/// 変更履歴15
///
/// 変更履歴16
/// @endparblock
void funcPar() {
// ・・・
}
HTMLの出力例
関数詳解
段落形式のコマンドは下記等が存在 (リンクは親サイト)
- @attention【注意】
- @author【開発者】・@authors【開発者】
- @copyright【著作権情報】
- @date【日付情報】
- @note【メモ・覚え書き】
- @remark・@remarks【備考】
- @since【有効バージョン】
- @version【バージョン】
- @warning【警告】
詳細な仕様は、親サイトの@par【ユーザ定義 (段落)】・ALIASES【エイリアス】 を参照
その他のコマンドについて、コマンド一覧 を参照