@code・@endcode【コードブロック】
@include【コードブロック (ファイル)】1.8.15 / 1.10.01.11.0
@includelineno【行番号付きコードブロック (ファイル)】1.8.15下位互換
@snippet【コードブロック (ファイル指定部分)】1.8.15 / 1.9.7 / 1.10.01.11.0
@snippetlineno【行番号付きコードブロック (ファイル指定部分)】1.8.15下位互換
@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【コードブロック (ファイル)】1.8.15 / 1.10.01.11.0
@includelineno【行番号付きコードブロック (ファイル)】1.8.15下位互換

メモ

概要

関連

外部リンク

構文

@include[{オプション}]1.8.15 ファイル名
@includelineno ファイル名 1.8.15下位互換

{オプション}1.8.15 (コマンド直後に指定)
    {lineno}行番号付き (@includelineno【行番号付きコードブロック (ファイル)】1.8.15下位互換 と同等)
    {local} 1.10.0ローカル環境のクラス・名前空間と見なす
    {doc}コマンド有効ドキュメント形式 (例外コマンドあり / @includedoc【ファイル挿入 (コマンド有効)】1.8.15下位互換 と同等)
    {doc,raise=レベル上げ量} 1.11.0ファイル内 @section【セクション】等の階層を指定量レベル上げ (下位階層へ)
        〔階層レベル:@tableofcontents【ページ内目次作成】参照〕
    {doc,prefix=プレフィックス} 1.11.0ファイル内 @section【セクション】セクション名等の識別名の前に指定プレフィックスを結合

/// ■@@include (通常:{lineno}未指定)
/// @include include.cpp
/// ■@@include{lineno}:行番号付き
/// @include{lineno} include.cpp
/// ■@@include (通常:{doc}未指定)
/// @include include.txt
/// ■@@include{doc}:ドキュメント形式 (コマンド有効)
/// @include{doc} include.txt
///
/// ■@@includelineno
/// @includelineno include.cpp

【include.cpp】

class ClassInclude
{
};

【include.txt】

@version 1.2.3
@author 開発者
@copyright 著作権情報

【HTML出力例】

■@include (通常:{lineno}未指定)

class ClassInclude
{
};

■@include{lineno}:行番号付き

1class ClassInclude
2{
3};

■@include (通常:{doc}未指定)

@version 1.2.3
@author 開発者
@copyright 著作権情報

■@include{doc}:ドキュメント形式 (コマンド有効)

バージョン
1.2.3
著者
開発者

■@includelineno

1class ClassInclude
2{
3};

@snippet【コードブロック (ファイル指定部分)】1.8.15 / 1.9.7 / 1.10.01.11.0
@snippetlineno【行番号付きコードブロック (ファイル指定部分)】1.8.15下位互換

メモ

概要

関連

外部リンク

構文

@snippet[{オプション}]1.8.15 ファイル名 スニペット識別子
@snippetlineno ファイル名 スニペット識別子1.8.15下位互換

{オプション}1.8.15 (コマンド直後に指定)
    {lineno}行番号付き (@snippetlineno【行番号付きコードブロック (ファイル指定部分)】1.8.15 と同等)
    {trimleft} 1.9.7左側余白削除 (TAB_SIZE【タブサイズ】考慮)
    {local} 1.10.0ローカル環境のクラス・名前空間と見なす
    {doc}コマンド有効ドキュメント形式 (例外コマンドあり / @snippetdoc【ファイル部分挿入 (コマンド有効)】1.8.15 と同等)
    {doc,raise=レベル上げ量} 1.11.0ファイル内 @section【セクション】等の階層を指定量レベル上げ (下位階層へ)
        〔階層レベル:@tableofcontents【ページ内目次作成】参照〕
    {doc,prefix=プレフィックス} 1.11.0ファイル内 @section【セクション】セクション名等の識別名の前に指定プレフィックスを結合

※指定ファイル内の[スニペット識別子]で囲まれた部分が対象

/// ■@@snippet (通常:{lineno}未指定)
/// @snippet snippet.cpp Snippet1
/// ■@@snippet{lineno}:行番号付き
/// @snippet{lineno} snippet.cpp Snippet1
/// ■@@snippet (通常:{trimleft}未指定)
/// @snippet snippet.cpp SnippetTrimLeft
/// ■@@snippet{trimleft}:左側余白削除
/// @snippet{trimleft} snippet.cpp SnippetTrimLeft
/// ■@@snippet (通常:{doc}未指定)
/// @snippet snippet.cpp SnippetDoc
/// ■@@snippet{doc}:ドキュメント形式 (コマンド有効)
/// @snippet{doc} snippet.cpp SnippetDoc
///
/// ■@@snippetlineno
/// @snippetlineno snippet.cpp Snippet2

【snippet.cpp】

// [Snippet1]
class ClassSnippet1
{
};
// [Snippet1]

// [Snippet2]
class ClassSnippet2
{
};
// [Snippet2]

class ClassSnippet3
{
    // [SnippetTrimLeft]
int method() {
        int sum = 0;
        for (int i = 1; i <= 10; i++) {
            sum += i;
        }
        return sum;
    }
    // [SnippetTrimLeft]
};

/*
[SnippetDoc]
@version 1.2.3
@author 開発者
@copyright 著作権情報
[SnippetDoc]
*/

【HTML出力例】

■@snippet (通常:{lineno}未指定)

class ClassSnippet1
{
};

■@snippet{lineno}:行番号付き

2class ClassSnippet1
3{
4};

■@snippet (通常:{trimleft}未指定)

int method() {
int sum = 0;
for (int i = 1; i <= 10; i++) {
sum += i;
}
return sum;
}

■@snippet{trimleft}:左側余白削除

int method() {
int sum = 0;
for (int i = 1; i <= 10; i++) {
sum += i;
}
return sum;
}

■@snippet (通常:{doc}未指定)

@version 1.2.3
@author 開発者
@copyright 著作権情報

■@snippet{doc}:ドキュメント形式 (コマンド有効)

バージョン
1.2.3
著者
開発者

■@snippetlineno

8class 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.