@code・@endcode【コードブロック】
@include【コードブロック (ファイル)】・@includelineno【行番号付きコードブロック (ファイル)】
@snippet【コードブロック (ファイル指定部分)】・@snippetlineno【行番号付きコードブロック (ファイル指定部分)】
@verbatim・@endverbatim【テキストブロック】
@verbinclude【テキストブロック (ファイル)】
@code【コードブロック (開始)】
@endcode【コードブロック (終了)】
メモ
- コードブロックを記述
- コードブロック内のクラス・メンバ等は自動的にリンク設定
- 関連
構文
@code [{ドット付ファイル拡張子 | .unparsed}]
【コードブロック】
@endcode
ドット付ファイル拡張子:
拡張子指定:対応する言語として解析
省略:コマンドの記述ファイルに従う
.unparsed:そのまま出力 (解析不要)
例:{.cpp}・{.py}・{.unparsed}
例
/// @code
/// class MyClass
/// {
/// ...
/// };
/// @endcode
///
/// @code {.py}
/// class MyClass:
/// ...
/// @endcode
HTML出力例
class MyClass
{
...
};
class MyClass:
...
@include【コードブロック (ファイル)】
@includelineno【行番号付きコードブロック (ファイル)】
メモ
- ファイル内容をコードブロックとして挿入
- @includelineno:行番号付きで挿入
- コードブロック内のクラス・メンバ等は自動的にリンク設定
- EXAMPLE_PATH【サンプルファイルパス】 でファイルのパス (複数指定可)を指定、 一意でない場合は絶対パスの指定が可能
- ファイルのエンコードは、DOXYFILE_ENCODING【ファイルのエンコード】
- 間引いて挿入する場合、@dontinclude【コードブロック (ファイル・非表示)】を参照
- 関連
構文
@include ファイル名
@includelineno ファイル名
例
/// @include include.cpp
/// @includelineno include.cpp
【include.cpp】
class CInclude
{
};
HTML出力例
class CInclude
{
};
1 class CInclude
2 {
3 };
@snippet【コードブロック (ファイル指定部分)】
@snippetlineno【行番号付きコードブロック (ファイル指定部分)】
メモ
- ファイル内容の指定部分をコードブロックとして挿入
- 行番号付き:@snippetlineno【行番号付きコードブロック (ファイル指定部分)】
- EXAMPLE_PATH【サンプルファイルパス】 でファイルのパス (複数指定可)を指定、 一意でない場合は絶対パスの指定が可能
- ファイルのエンコードは、DOXYFILE_ENCODING【ファイルのエンコード】
- 関連
構文
@snippet ファイル名 スニペット識別子
@snippetlineno ファイル名 スニペット識別子
ファイル内の[ スニペット識別子 ]で囲まれた部分が対象
例
/// @snippet snippet.cpp Snippet1
/// @snippetlineno snippet.cpp Snippet2
【snippet.cpp】
// [Snippet1]
class ClassSnippet1
{
};
// [Snippet1]
// [Snippet2]
class ClassSnippet2
{
};
// [Snippet2]
HTML出力例
class ClassSnippet1
{
};
8 class ClassSnippet2
9 {
10 };
@verbatim【テキストブロック (開始)】
@endverbatim【テキストブロック (終了)】
メモ
構文
@verbatim
【テキストブロック】
@endverbatim
例
/**
@verbatim
The quick brown fox jumps over the lazy dog.
The quick brown @em fox jumps over the lazy @b dog.
The quick brown fox jumps over the lazy dog.
@endverbatim
*/
HTML出力例
The quick brown fox jumps over the lazy dog. The quick brown @em fox jumps over the lazy @b dog. The quick brown fox jumps over the lazy dog.
@verbinclude【テキストブロック (ファイル)】
メモ
- ファイル内容をテキストブロックとして挿入
- コマンドは無効
- EXAMPLE_PATH【サンプルファイルパス】 でファイルのパス (複数指定可)を指定、 一意でない場合は絶対パスの指定が可能
- ファイルのエンコードは、DOXYFILE_ENCODING【ファイルのエンコード】
- 関連
構文
@verbinclude ファイル名
例
/// @verbinclude verbinclude.txt
【verbinclude.txt】
The quick brown fox jumps over the lazy dog.
The quick brown @em fox jumps over the lazy @b dog.
The quick brown fox jumps over the lazy dog.
HTML出力例
The quick brown fox jumps over the lazy dog. The quick brown @em fox jumps over the lazy @b dog. The quick brown fox jumps over the lazy dog.