Updated readme with package diagram examples

This commit is contained in:
Bartek Kryza
2022-01-22 21:10:57 +01:00
parent c8fbcc76e4
commit 7267a201a5
2 changed files with 41 additions and 3 deletions

View File

@@ -19,6 +19,8 @@ Main features supported so far include:
* Namespace based content filtering
* Sequence diagram generation
* Generation of sequence diagram from one code location to another
* Package diagram generation
* Generation of package diagram based on C++ namespaces (currently uses component symbols for packages, but it can be adjusted using skinparams)
## Installation
@@ -257,6 +259,43 @@ generates the following diagram (via PlantUML):
![sequence_diagram_example](docs/test_cases/t20001_sequence.png)
### Package diagrams
#### Example
The following C++ code:
```cpp
namespace clanguml {
namespace t30001 {
namespace A {
namespace AA {
namespace AAA {
} // namespace AAA
namespace BBB {
} // namespace BBB
} // namespace AA
namespace BB {
} // namespace BB
} // namespace A
namespace B {
namespace AA {
namespace AAA {
} // namespace AAA
namespace BBB {
} // namespace BBB
} // namespace AA
namespace BB {
} // namespace BB
} // namespace B
} // namespace t30001
} // namespace clanguml
```
generates the following diagram (via PlantUML):
![package_diagram_example](docs/test_cases/t30001_package.png)
### Test cases
The build-in test cases used for unit testing of the `clang-uml`, can be browsed [here](./docs/test_cases.md).

View File

@@ -1,4 +1,3 @@
namespace clanguml {
namespace t30001 {
namespace A {
@@ -21,5 +20,5 @@ namespace BBB {
namespace BB {
} // namespace BB
} // namespace B
}
}
} // namespace t30001
} // namespace clanguml