@dot・@enddot【DOT：テキストブロック】
@dotfile【DOT：ファイル挿入】
@callgraph【呼び出し関係図 (生成あり)】・@callergraph【被呼び出し関係図 (生成あり)】
@hidecallgraph【呼び出し関係図 (生成なし)】・@hidecallergraph【被呼び出し関係図 (生成なし)】

@dot【DOT：テキストブロック (開始)】
@enddot【DOT：テキストブロック (終了)】

メモ

構文

@dot ["キャプション"] [サイズ識別子=サイズ]
テキストブロック (DOT言語)
@enddot

キャプション：画像下のキャプション
サイズ識別子：width・height
サイズ：100px 等

例


/// @dot "caption"
/// digraph {
///     ClassDotA [ URL="@ref ClassDotA" ];
///     ClassDotB [ URL="@ref ClassDotB" ];
///     ClassDotA -> ClassDotB -> ClassDotC;
///     ClassDotB -> ClassDotD;
/// }
/// @enddot

/// クラスの説明
class ClassDotA {};
/// クラスの説明
class ClassDotB {};

【HTML出力例】

caption

@dotfile【DOT：ファイル挿入】

メモ

構文

@dotfile ファイル名 ["キャプション"] [サイズ識別子=サイズ]

ファイル名：挿入する画像ファイル名
キャプション：画像下のキャプション
サイズ識別子：width・height
サイズ：100px 等

例

/// @dotfile dotfile.dot "ファイル"

【dotfile.dot】

// DOT
graph graphfile {
    node [ shape = box ];
    "FileA" -- "FileB" -- "FileC";
    "FileB" -- "FileD";
}

【HTML出力例】

ファイル

@callgraph【呼び出し関係図 (生成あり)】
@callergraph【被呼び出し関係図 (生成あり)】

メモ

構文

@callgraph
@callergraph

例

/// クラスの説明
class ClassCall
{
public:
    /// メソッドＡの説明
    void methodA()
    {
        methodB();
    }
    /// メソッドＢの説明
    /// @callgraph
    /// @callergraph
    void methodB()
    {
        methodC();
        methodD();
    }
    /// メソッドＣの説明
    void methodC() { }
    /// メソッドＤの説明
    void methodD() { }
};

【HTML出力例 (methodB 部分)】

メソッドＢの説明

呼び出し関係図:
被呼び出し関係図:

@hidecallgraph【呼び出し関係図 (生成なし)】
@hidecallergraph【被呼び出し関係図 (生成なし)】

メモ

構文

@hidecallgraph
@hidecallergraph