diff --git a/Makefile b/Makefile index 4c79d05d..3ed817cb 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/README.md b/README.md index 52d666c7..6885a898 100644 --- a/README.md +++ b/README.md @@ -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