Skip to content

Commit

Permalink
iox-eclipse-iceoryx#590 Use PlantUML instead of plantuml in doc
Browse files Browse the repository at this point in the history
Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
  • Loading branch information
dkroenke committed May 12, 2021
1 parent e091d0e commit 463e7d2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions doc/aspice_swe3_4/swe_docu_guidelines.md
Expand Up @@ -15,7 +15,7 @@ To generate the documentation you need to install:
```bash
sudo apt install doxygen graphviz texlive-base texlive-font-utils texlive-latex-extra
```
The documentation we use plantuml for describing dynamic behavior in the code (sequence or activity diagrams).
The documentation we use PlantUML for describing dynamic behavior in the code (sequence or activity diagrams).
Needed package:
```bash
sudo apt install plantuml
Expand Down Expand Up @@ -103,7 +103,7 @@ See the header files under iceoryx/doc/aspice_swe3_4/example.

### PlantUML

if you want to make complex aspects of your implementation visible, you can write plantuml directly into the
if you want to make complex aspects of your implementation visible, you can write PlantUML directly into the
doxygen description of your class. An example can be found at [example_base_class.hpp](example/iceoryx_component/source/example_module/example_base_class.hpp)

Having PlantUML installed is not a must. If you want to use it you need to install it, and the variable `PLANTUML_JAR_PATH` needs to be set.
Expand Down
14 changes: 7 additions & 7 deletions doc/design/README.md
Expand Up @@ -7,10 +7,10 @@ In [draft](./draft/) are design drafts of current features contained which are u
implementation. The goal is to provide other developers a first idea on how
the feature can be used and how it will be implemented.

## Add diagrams using plantuml
## Add diagrams using PlantUML

Diagrams in the design documentation can be done with [plantuml](https://plantuml.com/).
For using plantuml we recommend to use the latest version with the following required packages:
Diagrams in the design documentation can be done with [PlantUML](https://plantuml.com/).
For using PlantUML we recommend to use the latest version with the following required packages:

```bash
sudo apt install default-jre-headless graphviz
Expand All @@ -19,11 +19,11 @@ sudo apt install default-jre-headless graphviz
A good online-editor with cheat-sheet can be found at [https://plantuml-editor.kkeisuke.com](https://plantuml-editor.kkeisuke.com).
Alternatively you can use extensions in your IDE.

The integration of the generated plantuml into your design documents is done via *.svg files.
You need to create a .puml file and export it to .svg afterwards for linking it with the markdown. In the tools folder is a helper script for that provided which downloads a defined version of plantuml to export the vector graphics.
These steps are necessary due to the current support of plantuml in [Github](https://github.community/t/support-uml-diagrams-in-markdown-with-plantuml-syntax/626).
The integration of the generated PlantUML into your design documents is done via *.svg files.
You need to create a .puml file and export it to .svg afterwards for linking it with the markdown. In the tools folder is a helper script for that provided which downloads a defined version of PlantUML to export the vector graphics.
These steps are necessary due to the current support of PlantUML in [Github](https://github.community/t/support-uml-diagrams-in-markdown-with-plantuml-syntax/626).

**NOTE:** Please set in the plantuml code the background manually to make all textboxes visible to users with dark-mode enabled in the Github-UI.
**NOTE:** Please set in the PlantUML code the background manually to make all textboxes visible to users with dark-mode enabled in the Github-UI.

```plantuml
@startuml
Expand Down

0 comments on commit 463e7d2

Please sign in to comment.