matthias/clang-uml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated Doxygen docs

Browse Source
This commit is contained in:
Bartek Kryza
2023-06-19 23:23:50 +02:00
parent 6dd4089c8d
commit fb348fbaa1
21 changed files with 2981 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/quick_start.md
View File

@@ -10,7 +10,7 @@ To add an initial class diagram to your project, follow these steps:
1. Enter your projects top level directory and run:
```bash
$ clang-uml --init
clang-uml --init
```
2. Edit the generated `.clang-uml` file and set the following:
```yaml
@@ -39,21 +39,21 @@ To add an initial class diagram to your project, follow these steps:
```
3. Run `clang-uml` in the projects top directory:
```bash
$ clang-uml
clang-uml
# or to see generation progress for each diagram run
$ clang-uml --progress
clang-uml --progress
```
4. Generate SVG images from the PlantUML diagrams:
```bash
$ plantuml -tsvg puml/*.puml
plantuml -tsvg puml/*.puml
```
5. Add another diagram:
```bash
$ clang-uml --add-sequence-diagram another_diagram
clang-uml --add-sequence-diagram another_diagram
```
6. Now list the diagrams defined in the config:
```bash
$ clang-uml -l
clang-uml -l
The following diagrams are defined in the config file:
- another_diagram [sequence]
- some_class_diagram [class]