個人的なプロジェクトで doxygen を使用しており、自分で作成したページ (マークダウン ページ) で任意の種類の UML 言語を使用したいと考えています。コードで使用するつもりはありません (動作します) が、自分で作成したドキュメントでは、以下の例を参照してください。
# Example
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts <br/>prevail!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
```plantuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
```
```mermaid
sequenceDiagram
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob:Another authentication Response
Bob --> Alice: Another authentication Response
```
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
@enduml
\startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
\enduml
出力は次のとおりです。
このテキストはtyporaに対して機能しますが(mermaid)、plantumlはgitlabでmermaidと一緒に生成されます。
doxygen -x Doxyfile
出力:
# Difference with default Doxyfile 1.8.17 (9b14bf58c30a02ef19abebec280568532dc58ed4)
PROJECT_NAME = Name
PROJECT_NUMBER = 0.0.1
PROJECT_BRIEF = "Brief"
OUTPUT_DIRECTORY = out
INLINE_INHERITED_MEMB = YES
INPUT = ./files \
../src/
RECURSIVE = YES
PLANTUML_JAR_PATH = /home/<SURNAME>/Installations/plantuml.jar
質問は:
doxygen のカスタム マークダウン ファイルで UML ダイアグラムを使用する方法。