Added target for generating clang-uml UML diagrams

This commit is contained in:
Bartek Kryza
2022-01-29 22:10:25 +01:00
parent 9cded5ddab
commit 9aca8368b4
2 changed files with 19 additions and 2 deletions

View File

@@ -52,6 +52,11 @@ test_plantuml: test
document_test_cases: test_plantuml
python3 util/generate_test_cases_docs.py
clanguml_diagrams: debug
mkdir -p docs/diagrams
debug/clang-uml
plantuml docs/diagrams/*.puml
.PHONY: submodules
submodules:
git submodule update --init --recursive

View File

@@ -89,8 +89,8 @@ diagrams:
myproject_class:
type: class
glob:
- src/**.h
- src/**.cc
- src/*.h
- src/*.cc
using_namespace:
- myproject
include:
@@ -106,6 +106,18 @@ diagrams:
See ![here](docs/configuration_file.md) for detailed configuration file reference guide.
### Examples
To see what `clang-uml` can do, checkout the test cases documentation [here](./docs/test_cases.md).
In order to see diagrams for the `clang-uml` itself, based on its own [config](.clang-uml) run
the following:
```bash
make clanguml_diagrams
```
and checkout the PNG diagrams in `docs/diagrams` folder.
### Class diagrams
#### Example