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

@file【ファイル情報】

メモ

構文

@file [ファイル名]

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

/// @file
/// @brief このファイルの概要
/// @author このファイルの開発者
/// @date このファイルの作成日
/// @details このファイルの詳細

/// @file ~.cpp
/// @brief 別ファイルの概要
/// @author 別ファイルの開発者
/// @date 別ファイルの作成日
/// @details 別ファイルの詳細

/// @file

/// @brief グローバル変数の概要
int valueGlobal;

/// @brief グローバル関数の概要
void funcGlobal() {}

@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【ファイル挿入 (コマンド有効)】

メモ

構文

@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