@file【ファイル情報】
@namespace【名前空間】
@includedoc【ファイル挿入 (コマンド有効)】
@snippetdoc【ファイル部分挿入 (コマンド有効)】
@file【ファイル情報】
メモ
- ファイル情報を記述
- グローバルな関数・変数・typedef・列挙型 (enum) を出力する場合、必須
- 関連
構文
@file [ファイル名]
ファイル名:一意でない場合、パスを含むことが可能 (INPUT【ソースファイル名・ディレクトリ名】)
(省略):現在のファイルが対象
例
/// @file ~.h
/// @brief ヘッダファイルの説明
/// @file
/// @brief このファイルの説明
/// グローバル変数の説明
int valueGlobal;
/// グローバル関数の説明
void funcGlobal() {}
@namespace【名前空間】
メモ
- 名前空間を記述
- 通常は省略
- 別の位置に記述する場合に使用
- 関連
構文
@namespace 名前空間名
例
/// 名前空間A (省略形)
namespace NamespaceA
{
}
namespace NamespaceB
{
}
/// @namespace NamespaceB
/// @brief 名前空間B
@includedoc【ファイル挿入 (コマンド有効)】
メモ
- ファイル内容の挿入を記述
- コマンド有効 (例外: @cond【条件付きセクション (開始)】 ・@if【条件付きコメント (if)】 ・@todo【TODO (一覧)】 等)
- EXAMPLE_PATH【サンプルファイルパス】 でファイルのパス (複数指定可)を指定、 一意でない場合は絶対パスの指定が可能
- ファイルのエンコードは、DOXYFILE_ENCODING【ファイルのエンコード】
- 関連
- @include【コードブロック (ファイル)】・@includelineno【行番号付きコードブロック (ファイル)】
- @snippetdoc【ファイル部分挿入 (コマンド有効)】
- Doxygen Special Commands (英語): \includedoc
構文
@includedoc ファイル名
例
/// @includedoc includedoc.txt
【includedoc.txt】
@version 1.2.3
@author 開発者
@copyright 著作権情報
【HTML出力例】
- バージョン
- 1.2.3
- 著作権所有
- 著作権情報
@snippetdoc【ファイル部分挿入 (コマンド有効)】
メモ
- ファイル内容の指定部分の挿入を記述
- コマンド有効 (例外: @cond【条件付きセクション (開始)】 ・@if【条件付きコメント (if)】 ・@todo【TODO (一覧)】 等)
- EXAMPLE_PATH【サンプルファイルパス】 でファイルのパス (複数指定可)を指定、 一意でない場合は絶対パスの指定が可能
- ファイルのエンコードは、DOXYFILE_ENCODING【ファイルのエンコード】
- 関連
構文
@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