@file【ファイル情報】
@namespace【名前空間】
@includedoc【ファイル挿入 (コマンド有効)】
@snippetdoc【ファイル部分挿入 (コマンド有効)】

@file【ファイル情報】

メモ

構文

@file [ファイル名]

ファイル名:一意でない場合、パスを含むことが可能 (INPUT【ソースファイル名・ディレクトリ名】)
(省略):現在のファイルが対象

/// @file ~.h
/// @brief ヘッダファイルの説明

/// @file
/// @brief このファイルの説明

/// グローバル変数の説明
int valueGlobal;
/// グローバル関数の説明
void funcGlobal() {}

@namespace【名前空間】

メモ

構文

@namespace 名前空間名

/// 名前空間A (省略形)
namespace NamespaceA
{
}

namespace NamespaceB
{
}
/// @namespace NamespaceB
/// @brief 名前空間B

@includedoc【ファイル挿入 (コマンド有効)】

メモ

構文

@includedoc ファイル名

/// @includedoc includedoc.txt

【includedoc.txt】

@version 1.2.3
@author 開発者
@copyright 著作権情報

【HTML出力例】

バージョン
1.2.3
著者
開発者

@snippetdoc【ファイル部分挿入 (コマンド有効)】

メモ

構文

@snippetdoc ファイル名

ファイル内の[ スニペット識別子 ]で囲まれた部分が対象

/// @snippetdoc snippetdoc.txt SnippetB

【snippetdoc.txt】

[SnippetA]
@version 2.3.4
@author 開発者A
@copyright 著作権情報A
[SnippetA]

[SnippetB]
@version 3.4.5
@author 開発者B
@copyright 著作権情報B
[SnippetB]

【HTML出力例】

バージョン
3.4.5
著者
開発者B