Updated readme with package diagram examples
This commit is contained in:
39
README.md
39
README.md
@@ -19,6 +19,8 @@ Main features supported so far include:
|
|||||||
* Namespace based content filtering
|
* Namespace based content filtering
|
||||||
* Sequence diagram generation
|
* Sequence diagram generation
|
||||||
* Generation of sequence diagram from one code location to another
|
* 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
|
## Installation
|
||||||
|
|
||||||
@@ -257,6 +259,43 @@ generates the following diagram (via PlantUML):
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
### 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):
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### Test cases
|
### Test cases
|
||||||
|
|
||||||
The build-in test cases used for unit testing of the `clang-uml`, can be browsed [here](./docs/test_cases.md).
|
The build-in test cases used for unit testing of the `clang-uml`, can be browsed [here](./docs/test_cases.md).
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
namespace clanguml {
|
namespace clanguml {
|
||||||
namespace t30001 {
|
namespace t30001 {
|
||||||
namespace A {
|
namespace A {
|
||||||
@@ -21,5 +20,5 @@ namespace BBB {
|
|||||||
namespace BB {
|
namespace BB {
|
||||||
} // namespace BB
|
} // namespace BB
|
||||||
} // namespace B
|
} // namespace B
|
||||||
}
|
} // namespace t30001
|
||||||
}
|
} // namespace clanguml
|
||||||
|
|||||||
Reference in New Issue
Block a user