@if・@ifnot・@else・@elseif・@endif【条件付きコメント】
@cond・@endcond【条件付きセクション】
@noop【無視コマンド】1.8.17
@raisewarning【警告メッセージ出力】1.9.3
@doxyconfig【設定オプション値出力】1.9.7

@if【条件付きコメント (if)】
@ifnot【条件付きコメント (ifnot)】
@else【条件付きコメント (else)】
@elseif【条件付きコメント (elseif)】
@endif【条件付きコメント (終了)】

メモ

構文

@if セクションラベル
@ifnot セクションラベル

@else 
@elseif セクションラベル

@endif

セクションラベル：下記が指定可能
指定項目備考
条件付きセクション
( 式 )以降の式を使用する場合、必須
&&AND
||OR
!NOT

例

/// @if RELEASE
///   @note リリース モード
/// @elseif DEBUG
///   @note デバッグ モード
/// @else
///   @note テスト モード
/// @endif
/// @ifnot TEST
///   @note リリース または デバッグ モード
/// @else
///   @note テスト モード
/// @endif

@cond【条件付きセクション (開始)】
@endcond【条件付きセクション (終了)】

メモ

構文

@cond [セクションラベル]
@endcond

セクションラベル：省略は、出力無し (下記が指定可能)
指定項目備考
条件付きセクション
( 式 )以降の式を使用する場合、必須
&&AND
||OR
!NOT

例

/// @cond COND1
/// クラスの説明 (COND1定義で出力)
class ClassCond1 {};
/// @endcond

/// @cond (COND1 || COND2)
/// クラスの説明 (COND1 または COND2定義で出力)
class ClassCond12 {};
/// @endcond

/// @cond COND1
/// @cond COND2
/// クラスの説明 (COND1 かつ COND2定義で出力)
class ClassCond3 {};
/// @endcond
/// @endcond

/// @cond
/// クラスの説明 (出力なし)
class ClassCondNG {};
/// @endcond

@noop【無視コマンド】1.8.17

メモ

  • 無視されるコマンドを記述
    • エイリアスを使用し Doxygen がサポートしていない他ツールのコマンド等を無効化
  • 関連

構文

@noop 無視されるテキスト

例

ALIASES【エイリアス】

notsupport=@noop


/// @notsupport 未サポートコマンドの情報
class ClassDummy {};

@raisewarning【警告メッセージ出力】1.9.3

メモ

構文

@raisewarning 警告メッセージ

例

ALIASES【エイリアス】

unfixed=@raisewarning 未定
unfixed_1{1}=@raisewarning 未定 (\1)


/// @raisewarning 警告メッセージ
/// @unfixed
/// @unfixed_1{詳細メッセージ}
class Class_1_9_3
{
};

【出力例】

...
～.cpp:nn: warning: 警告メッセージ
～.cpp:nn: warning: 未定
～.cpp:nn: warning: 未定 (詳細メッセージ)
...
*** Doxygen has finished

@doxyconfig【設定オプション値出力】1.9.7

メモ

構文

@doxyconfig 設定オプション

例

/// INPUT_ENCODING【ファイルのエンコード】= @doxyconfig INPUT_ENCODING @n
/// DOXYFILE_ENCODING【設定ファイルのエンコード】= @doxyconfig DOXYFILE_ENCODING @n
/// OUTPUT_LANGUAGE【出力言語】= @doxyconfig OUTPUT_LANGUAGE @n
/// GENERATE_HTML【HTML 出力有無】= @doxyconfig GENERATE_HTML

【設定ファイル抜粋 (デフォルト名：Doxyfile)】

INPUT_ENCODING         = UTF-8
DOXYFILE_ENCODING      = UTF-8
OUTPUT_LANGUAGE        = Japanese
GENERATE_HTML          = YES

【HTML 出力例】

INPUT_ENCODING【ファイルのエンコード】= UTF-8
DOXYFILE_ENCODING【設定ファイルのエンコード】= UTF-8
OUTPUT_LANGUAGE【出力言語】= Japanese
GENERATE_HTML【HTML 出力有無】= YES