@msc・@endmsc【シーケンスチャート：テキストブロック】
@mscfile【シーケンスチャート：ファイル挿入】
@startuml・@enduml【UML：テキストブロック】1.9.2 / 1.9.7 / 1.11.01.12.0
@diafile【Dia：図表ファイル挿入】
@msc【シーケンスチャート：テキストブロック (開始)】
@endmsc【シーケンスチャート：テキストブロック (終了)】
メモ
- メッセージシーケンスチャート(Message Sequence Chart)のテキストブロックを記述
- Mscgen を使用 (組み込み 1.8.16 )
MSCGEN_TOOL【MSG外部作成ツール】指定で外部ツールも使用可 1.9.7 - URL 属性の @ref【インライン参照】でリンク作成
- Mscgen を使用 (組み込み 1.8.16 )
- 関連
構文
@msc ["キャプション"] [サイズ識別子=サイズ]
シーケンスチャートのテキストブロック
@endmsc
サイズ識別子：width・height
サイズ：100px 等
例
/// @msc "@@msc"
/// c [label="Client"],s [label="Server"];
/// c=>s [label = "MSG1", URL = "@ref msg1"];
/// c<=s [label = "MSG2", URL = "@ref msg2"];
/// @endmsc
【HTML出力例】
@msc
@mscfile【シーケンスチャート：ファイル挿入】
メモ
- メッセージシーケンスチャート(Message Sequence Chart)のテキストファイル挿入を記述
- Mscgen を使用 (組み込み 1.8.16 )
MSCGEN_TOOL【MSG外部作成ツール】指定で外部ツールも使用可 1.9.7 - URL 属性の @ref【インライン参照】でリンク作成
- MSCFILE_DIRS【mscファイルパス】でファイルのパス (複数指定可)を指定、 一意でない場合は絶対パスの指定が可能
- Mscgen を使用 (組み込み 1.8.16 )
- 関連
構文
@mscfile ファイル名 ["キャプション"] [サイズ識別子=サイズ]
ファイル名：スペースが含まれる場合、"ファイル名"
サイズ識別子：width・height
サイズ：100px 等
例
/// @mscfile mscfile.msc "mscfile.msc"
【mscfile.msc】
// Mscgen
msc {
A,B,C;
A box A [label="BOX", textbgcolor="yellow"];
B rbox B [label="RBOX"];
B note C [label="NOTE", textbgcolor="silver"];
A-xB [label="NG"];
A=>>B [label="MSG1"];
B=>C [label="MSG2"];
C=>C [linecolor="red"];
A<<C [label="return"];
}
【HTML出力例】
mscfile.msc
@startuml【UML：テキストブロック (開始)】1.9.2 / 1.9.7 / 1.11.01.12.0
@enduml【UML：テキストブロック (終了)】
メモ
- UML (Unified Modeling Language) のテキストブロックを記述
- PlantUML を使用
- UML以外の図もサポート (WBS 図・ガントチャート 等)
- Tips
- 中間ファイルの “inline_umlgraph_cache_all.pu” でエラーになる場合は、実行前に削除
- 関連
- 図の生成・挿入
- PLANTUML_JAR_PATH【plantuml.jar ファイルのパス】
PLANTUML_CFG_FILE【PlantUMLの設定ファイル】
PLANTUML_INCLUDE_PATH【PlantUMLのインクルードファイルのパス (複数指定可)】 - @dot・@enddot【DOT：テキストブロック】
- @msc・@endmsc【シーケンスチャート：テキストブロック】
- 子サイト：『Q&A：Doxygenで構造を記述して各種UML図・メッセージシーケンスチャート・フローチャート等を出力するには？』
- PlantUML
- Doxygen Special Commands (英語)： \startuml ・\enduml
構文
@startuml [{オプション}] ["キャプション"] [サイズ識別子=サイズ]
UMLのテキストブロック
@enduml
オプション (複数：カンマ区切り)：オプション (複数指定可1.9.2 )
ファイル名 (最大１個)：生成される画像名 (省略：自動的に名前付け)
エンジン (最大１個)1.9.2：PlantUML の @start～ コマンドに対応 (下記 参照)
キャプション：画像下のキャプション
サイズ識別子：width・height
サイズ：100px 等
| エンジン | 備考 |
|---|---|
| uml (デフォルト) 1.9.2 | UML |
| bpm 1.9.2 | BPM |
| wire 1.9.2 | ワイヤーフレーム |
| dot 1.9.2 | DOT |
| ditaa 1.9.2 | Ditaa |
| salt 1.9.2 | Salt |
| math 1.9.2 | 数式 |
| latex 1.9.2 | LaTeX |
| gantt 1.9.2 | ガントチャート |
| mindmap 1.9.2 | マインドマップ |
| wbs 1.9.2 | WBS図 |
| yaml 1.9.2 | YAML |
| creole 1.9.2 | Creole |
| json 1.9.2 | JSON |
| flow 1.9.2 | フローチャート・アクティビティ図 |
| board 1.9.2 | ボード図 |
| git 1.9.2 | Git |
| hcl 1.9.7 | HCL |
| regex 1.9.7 | 正規表現 |
| ebnf 1.9.7 | EBNF |
| files 1.11.0 | ディレクトリ ツリー リスト |
| chen 1.12.0 | ER図 |
| chronology 1.12.0 | シーケンス図 |
例
/// @startuml {uml.png} "アクティビティ図"
/// start
/// if (判定 ? ) then(yes)
/// :処理Ａ;
/// else (no)
/// :処理Ｂ;
/// endif
/// stop
/// @enduml
【HTML出力例】
アクティビティ図
/// @startuml {wbs} "WBS"
/// * WBS 0
/// ** WBS 1
/// *** WBS 1-1
/// *** WBS 1-2
/// ** WBS 2
/// *** WBS 2-1
/// *** WBS 2-2
/// @enduml
【HTML出力例】
WBS
@diafile【Dia：図表ファイル挿入】
メモ
- Dia で作成した図表ファイル挿入を記述
- DIA_PATH【Diaファイルパス】でファイルのパスを指定
- Dia で日本語入力不可の場合、[入力メソッド] を [シンプル] に設定
- 関連
構文
@diafile ファイル名 ["キャプション"] [サイズ識別子=サイズ]
ファイル名：スペースが含まれる場合、"ファイル名"
サイズ識別子：width・height
サイズ：100px 等
例
/// @diafile Diagram.dia "フローチャート"
【HTML出力例】
フローチャート