@file【ファイル情報】
@fileinfo【ファイル名 (インライン)】1.9.5
@lineinfo【行番号 (インライン)】1.9.5
@namespace【名前空間】
@includedoc【ファイル挿入 (コマンド有効)】1.8.15
@snippetdoc【ファイル部分挿入 (コマンド有効)】1.8.15
@file【ファイル情報】
メモ
- ファイル情報を記述
- グローバルな関数・変数・型定義 (typedef)・列挙型 (enum)・構造体 等を出力する場合、必須 (@file のみで可)
- 自ファイルでは、通常はファイル名省略
別ファイルに記述する場合にファイル名指定
- 関連
- 外部リンク
構文
@file [ファイル名]
ファイル名:一意でない場合、パスを含むことが可能 (INPUT【ソースファイル名・ディレクトリ名】)
省略:現在のファイルが対象
例
@fileinfo【ファイル名 (インライン)】1.9.5
メモ
- ファイル名をインライン出力
- ファイル名・拡張子・フルパス名 等を指定
- 関連
構文
@fileinfo[{オプション}]
オプション: 出力部分 (下記参照)
オプション | 備考 |
---|---|
directory | ファイルのディレクトリ |
extension | ファイルの拡張子 |
filename { }を含めて省略 | ファイル名 (拡張子あり) |
full | フルパス名 |
name | ファイル名 (拡張子なし) |
例
【ver-1-9-5.cpp】
/// @file
/// 行番号:@lineinfo@n
/// ファイル名 (インライン)@n
/// ファイルのディレクトリ:@fileinfo{directory}@n
/// ファイルの拡張子:@fileinfo{extension}@n
/// ファイル名 (拡張子あり):@fileinfo{filename}@n
/// 省略:@fileinfo@n
/// フルパス名:@fileinfo{full}@n
/// ファイル名 (拡張子なし):@fileinfo{name}@n
/// 行番号:@lineinfo
【HTML出力例】
行番号:2
ファイル名 (インライン)
ファイルのディレクトリ:C:/~
ファイルの拡張子:cpp
ファイル名 (拡張子あり):ver-1-9-5.cpp
省略:ver-1-9-5.cpp
フルパス名:C:/~/ver-1-9-5.cpp
ファイル名 (拡張子なし):ver-1-9-5
行番号:10
@lineinfo【行番号 (インライン)】1.9.5
メモ
- ファイルの行番号をインライン出力
- 関連
構文
@lineinfo
例
【ver-1-9-5.cpp】
/// @file
/// 行番号:@lineinfo@n
/// ファイル名 (インライン)@n
/// ファイルのディレクトリ:@fileinfo{directory}@n
/// ファイルの拡張子:@fileinfo{extension}@n
/// ファイル名 (拡張子あり):@fileinfo{filename}@n
/// 省略:@fileinfo@n
/// フルパス名:@fileinfo{full}@n
/// ファイル名 (拡張子なし):@fileinfo{name}@n
/// 行番号:@lineinfo
【HTML出力例】
行番号:2
ファイル名 (インライン)
ファイルのディレクトリ:C:/~
ファイルの拡張子:cpp
ファイル名 (拡張子あり):ver-1-9-5.cpp
省略:ver-1-9-5.cpp
フルパス名:C:/~/ver-1-9-5.cpp
ファイル名 (拡張子なし):ver-1-9-5
行番号:10
@namespace【名前空間】
メモ
- 名前空間を記述
- 定義の直前では、通常は省略
その他の位置に記述する場合に使用
- 定義の直前では、通常は省略
- 関連
- 外部リンク
構文
@namespace 名前空間名
例
/// @brief 名前空間Aの概要
/// @details 名前空間Aの詳細
/// @note @@namespace 省略
namespace NamespaceA
{
}
namespace NamespaceB
{
}
/// @namespace NamespaceB
/// @brief 名前空間Bの概要
/// @details 名前空間Bの詳細
@includedoc【ファイル挿入 (コマンド有効)】1.8.15
メモ
- 廃止 (下位互換の為、残存) 1.8.15
- 代替:@include【コードブロック (ファイル)】のオプション指定
- ファイル内容の挿入を記述
- コマンド有効 (例外: @cond【条件付きセクション (開始)】 ・@if【条件付きコメント (if)】 ・@todo【TODO (一覧)】 等)
- EXAMPLE_PATH【例ファイルパス】 でファイルのパス (複数指定可)を指定、 一意でない場合は絶対パスの指定が可能
- ファイルのエンコードは、INPUT_ENCODING【ファイルのエンコード】・ INPUT_FILE_ENCODING【個別ファイルのエンコード】
- 関連
- @include【コードブロック (ファイル)】・@includelineno【行番号付きコードブロック (ファイル)】
- @snippetdoc【ファイル部分挿入 (コマンド有効)】
- Doxygen Special Commands (英語): \includedoc
構文
@includedoc ファイル名1.8.15
例
/// @includedoc includedoc.txt
【includedoc.txt】
@version 1.2.3
@author 開発者
@copyright 著作権情報
【HTML出力例】
- バージョン
- 1.2.3
- 著作権所有
- 著作権情報
@snippetdoc【ファイル部分挿入 (コマンド有効)】1.8.15
メモ
- 廃止 (下位互換の為、残存) 1.8.15
- 代替:@snippet【コードブロック (ファイル指定部分)】のオプション指定
- ファイル内容の指定部分の挿入を記述
- コマンド有効 (例外: @cond【条件付きセクション (開始)】 ・@if【条件付きコメント (if)】 ・@todo【TODO (一覧)】 等)
- EXAMPLE_PATH【例ファイルパス】 でファイルのパス (複数指定可)を指定、 一意でない場合は絶対パスの指定が可能
- ファイルのエンコードは、INPUT_ENCODING【ファイルのエンコード】・ INPUT_FILE_ENCODING【個別ファイルのエンコード】
- 関連
構文
@snippetdoc ファイル名 スニペット識別子 1.8.15
ファイル内の[スニペット識別子]で囲まれた部分が対象
例
/// @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