From 7267a201a5c1836276235dc1ac38f1c8d811ec76 Mon Sep 17 00:00:00 2001 From: Bartek Kryza Date: Sat, 22 Jan 2022 21:10:57 +0100 Subject: [PATCH] Updated readme with package diagram examples --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ tests/t30001/t30001.cc | 5 ++--- 2 files changed, 41 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5f206cbd..11d49ec0 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/tests/t30001/t30001.cc b/tests/t30001/t30001.cc index 98e901ce..822ef9af 100644 --- a/tests/t30001/t30001.cc +++ b/tests/t30001/t30001.cc @@ -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