Skip to content

Commit

Permalink
Added plantUML description; fixed some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Florian Baeuerlein committed Sep 10, 2020
1 parent 785d411 commit 485ba3a
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 6 deletions.
27 changes: 21 additions & 6 deletions doc/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
- [Overview](#overview)
- [doxygen](#doxygen)
- [Markdown](#markdown)
- [PlantUML](#plantuml)
- [References](#references)

---

Expand All @@ -21,7 +23,7 @@ Adding doxygen language support could be done by installing the [doxygen extensi

To support you with automated comment templates in your code, the [Doxygen Documentation Generator](https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen) is very useful.

![Doxygen in action](images/doxygen.png)
![Doxygen in action](../images/doxygen.png)

To install doxygen:

Expand All @@ -31,20 +33,33 @@ For enhanced visualization in doxygen, install graphviz.

apt install graphviz

If you like easy visualization of customizable sequence charts, maybe mscgen is the right thing for you. You can install it with:

apt install mscgen

To run doxygen from VS Code, the [Doxygen Runner extension](https://marketplace.visualstudio.com/items?itemName=betwo.vscode-doxygen-runner) is helpful.

Simply install the extension, add a `Doxyfile` to your workspace folder (e.g. with `doxygen -g`) and change the `settings.json` accordingly.

"doxygen_runner.configuration_file_override": "${workspaceFolder}/Doxyfile"

Finally you can start doxygen via the command palette (`Ctrl+Shift+P`), selecting **Generate Doxygen generation**.
Finally you can start doxygen via the command palette (`Ctrl+Shift+P`), selecting **Generate Doxygen documentation**.

---

## Markdown

There are several markdown related extensions available. But currently a very nice one is [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one#table-of-contents). It supports shortcuts, automated creation of TOCs and many more.

---

## PlantUML

If you like to enrich your documentation with nice UML diagrams, the [PlantUML](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) extension is the right choice. It supports you with syntax highlighting of plantUML files and a very cool preview windows that displays your diagrams during creation. To show the preview on a pure plantUML file or embedded within doxygen/markdown use the command palette (`Ctrl+Shift+P`) and run **PlantUML: Preview Current Diagram**. The diagrams could also be exported in various formats.

![PlantUML in action](../images/plantUML.gif)

As mentioned, it could also be integrated with doxygen. The diagrams are automatically generated and included in your documentation then.

---

## References

- Official Doxygen site: [https://www.doxygen.nl/index.html](https://www.doxygen.nl/index.html)
- PlantUML Website: [https://plantuml.com](https://plantuml.com)
6 changes: 6 additions & 0 deletions doc/plantuml_test.pu
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
@startuml

actor Me
Me -> You : show PlantUML
You -> Other : look, that's nice
@enduml
Binary file added images/plantUML.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 485ba3a

Please sign in to comment.