Updated readme with include diagram section
This commit is contained in:
22
README.md
22
README.md
@@ -302,6 +302,26 @@ generates the following diagram (via PlantUML):
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
### Include diagrams
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
The following C++ code structure:
|
||||||
|
|
||||||
|
```
|
||||||
|
tests/t40001
|
||||||
|
├── include
|
||||||
|
│ ├── lib1
|
||||||
|
│ │ └── lib1.h
|
||||||
|
│ └── t40001_include1.h
|
||||||
|
└── src
|
||||||
|
└── t40001.cc
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
generates the following diagram (via PlantUML) based on include directives in the code:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### Default mappings
|
### Default mappings
|
||||||
|
|
||||||
@@ -314,6 +334,8 @@ generates the following diagram (via PlantUML):
|
|||||||
| Composition |  |
|
| Composition |  |
|
||||||
| Template specialization/instantiation |  |
|
| Template specialization/instantiation |  |
|
||||||
| Nesting (inner class/enum) |  |
|
| Nesting (inner class/enum) |  |
|
||||||
|
| Include (local) |  |
|
||||||
|
| Include (system) |  |
|
||||||
|
|
||||||
### Diagram content filtering
|
### Diagram content filtering
|
||||||
For typical code bases, generating a single diagram from entire code or even a single namespace can be too big to
|
For typical code bases, generating a single diagram from entire code or even a single namespace can be too big to
|
||||||
|
|||||||
Reference in New Issue
Block a user