@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【行番号付きコードブロック (ファイル)】

メモ

構文

@include ファイル名
@includelineno ファイル名

例

/// @include include.cpp
/// @includelineno include.cpp

【include.cpp】

class CInclude
{
};

HTML出力例

class CInclude
{
};
    1 class CInclude
    2 {
    3 };

@snippet【コードブロック (ファイル指定部分)】
@snippetlineno【行番号付きコードブロック (ファイル指定部分)】

メモ

構文

@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【テキストブロック (ファイル)】

メモ

構文

@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.