Skip to content
Snippets Groups Projects
Commit 0e2b54b9 authored by René Schöne's avatar René Schöne
Browse files

0.2.1

- fix and update documentation
parent fe18e34c
No related branches found
No related tags found
No related merge requests found
Pipeline #12754 passed
#Thu Feb 24 16:08:53 CET 2022
version=0.2
#Thu Feb 24 16:54:04 CET 2022
version=0.2.1
# Grammar2Uml
The tool called `Grammar2Uml` ([see in repo](https://git-st.inf.tu-dresden.de/jastadd/grammar2uml/-/tree/main/grammar2uml)) takes a set of grammar specifications and creates a visualization similar to UML class diagrams.
The tool called `Grammar2Uml` ([see in repo](https://git-st.inf.tu-dresden.de/jastadd/grammar2uml)) takes a set of grammar specifications and creates a visualization similar to UML class diagrams.
![](img/grammar2uml.png)
![](img/minimal-example.png)
Every nonterminal will be shown as a rectangular box with its terminal children listed within it. Children are shown as containment relations between parent and child, whereas relations and intrinsic references are shown using arrows.
Furthermore, some options may be specified.
| Name | Required (Default) | Description |
|----------------------|--------------------|-------------------------------------------------------------------------|
| `--output` | No (`uml.md`) | target file to be generated. |
| `--inputGrammar2Uml` | No | grammar2uml definition file, see [below](#grammar2uml-definition-file). |
| `--defaultFolders` | No (`false`) | Creates a default folder per grammar file. |
| `--help` | No | Print usage and exit. |
| `--version` | No | Print version and exit. |
| `--verbose` | No | Print more messages while compiling. |
Furthermore, more options may be specified.
| Name | Description |
|----------------------|-------------------------------------------------------------------------|
| `--output` | target file to be generated (default: `uml.md` or `uml.png`, depending on `--printSource`) |
| `--inputGrammar2Uml` | grammar2uml definition file, see [below](#grammar2uml-definition-file). |
| `--printSource` | If set, the output will be the source code instead of a png. (default: create a png) |
| `--defaultFolders` | If set, creates a default folder per grammar file. (default: use one global folder) |
| `--help` | Print usage and exit. |
| `--version` | Print version and exit. |
| `--verbose` | Print more messages while compiling. |
## Grammar2uml definition file
......
......@@ -3,7 +3,6 @@ repo_url: https://git-st.inf.tu-dresden.de/jastadd/grammar2uml
site_dir: ../public
nav:
- "grammar2uml": grammar2uml.md
- "API documentation": ragdoc/index.html
theme:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment