diff options
| author | Dimitri van Heesch <doxygen@gmail.com> | 2021-05-01 12:05:36 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <doxygen@gmail.com> | 2021-05-01 12:05:36 (GMT) |
| commit | 22ce9444ca5c73c8a343685309c1812c7f8d263b (patch) | |
| tree | ff40f0535e20dbecdb9c061e4d6b7b30a7a63625 /doc | |
| parent | 65ad3c5747b855c34498f822a65e1492f1495983 (diff) | |
| parent | 0dbc0d1c0b58bc06651137cd310a945a1db25151 (diff) | |
| download | Doxygen-22ce9444ca5c73c8a343685309c1812c7f8d263b.zip Doxygen-22ce9444ca5c73c8a343685309c1812c7f8d263b.tar.gz Doxygen-22ce9444ca5c73c8a343685309c1812c7f8d263b.tar.bz2 | |
Merge branch 'feature/bug_startuml' of https://github.com/albert-github/doxygen into albert-github-feature/bug_startuml
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index e88c68a..3c78f7b 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2954,19 +2954,31 @@ class Receiver \sa section \ref cmdmscfile "\\mscfile". <hr> -\section cmdstartuml \\startuml [{file}] ["caption"] [<sizeindication>=<size>] +\section cmdstartuml \\startuml ['{'option[,option]'}'] ["caption"] [<sizeindication>=<size>] \addindex \\startuml + Starts a text fragment which should contain a valid description of a PlantUML diagram. See https://plantuml.com/ for examples. The text fragment ends with \ref cmdenduml "\\enduml". \note You need to install Java and the PlantUML's jar file, - if you want to use this command. The location of the jar file should be specified - using \ref cfg_plantuml_jar_path "PLANTUML_JAR_PATH". + if you want to use this command. When using PlantUML in \LaTeX you have to download + some more `jar` files, for details see the PlantUML documentation. + The location of the jar file should be specified using + \ref cfg_plantuml_jar_path "PLANTUML_JAR_PATH". + + Not all diagrams can be created with the PlantUML `@startuml` command but need another + PlantUML `@start...` command. This wil look like `@start<engine>` where currently supported are + the following `<engine>`'s: `uml`, `bpm`, `wire`, `dot`, `ditaa`, `salt`, `math`, `latex`, + `gantt`, `mindmap`, `wbs`, `yaml`, `creole`, `json`, `flow`a, `board` and `git`.s + By default the `<engine>` is `uml`. The `<engine>` can be specified as an option. + Also the file to write the resulting image to can be specified by means of an option, see the + description of the first (optional) argument for details. + Of course only one `<engine>` can be specified and also the filename can only be specified once. The first argument is optional and is for compatibility with running PlantUML as a preprocessing - step before running doxygen, you can also add the name of the image file after \c \\startuml - and inside curly brackets, i.e. + step before running doxygen, you can also add the name of the image file after `\startuml` + and inside curly brackets as option, i.e. \verbatim @startuml{myimage.png} "Image Caption" width=5cm Alice -> Bob : Hello |