matthias/clang-uml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed documentation typos

Browse Source
This commit is contained in:
Bartek Kryza
2023-01-02 21:00:40 +01:00
parent 93360282ad
commit d140c1f1a1
4 changed files with 19 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/class_diagrams.md
View File

@@ -29,7 +29,7 @@ The basic class diagram generated by `clang-uml` and rendered using PlantUML loo
![extension](test_cases/t00003_class.svg)
Parameter types and method return types are rendered at the end after `:` sign.
Member types and method return types are rendered at the end after `:` sign.
Static methods and members are underlined.
@@ -67,8 +67,6 @@ The following table presents the PlantUML arrows representing each relationship
| Composition | ![composition](img/puml_composition.png) |
| Template specialization/instantiation | ![specialization](img/puml_instantiation.png) |
| Nesting (inner class/enum) | ![nesting](img/puml_nested.png) |
| Include (local) | ![association](img/puml_association.png) |
| Include (system) | ![dependency](img/puml_dependency.png) |
By default, a member from which a relationship has been added to the diagram between 2 classes will also be rendered
@@ -80,7 +78,7 @@ include_relations_also_as_members: false
### Relationships to classes in containers or smart pointers
`clang-uml` will automatically detect class members as well as method arguments, which reference or own
values of types relevant for a given diagram but wrapped in smart pointers or containers ang still generate
values of types relevant for a given diagram but wrapped in smart pointers or containers and still generate
relationship between these classes, for instance the following code:
```cpp
@@ -130,7 +128,7 @@ which results in the following diagram:
## Class context diagram
Sometimes it's helpful to generate a class diagram depicting only direct relationships of a given class, e.g.
within the classes documentation page, this can be easily achieved using `context` inclusion filter:
within the classes' documentation page, this can be easily achieved using `context` inclusion filter:
```yaml
include:
@@ -144,7 +142,7 @@ diagram:
![extension](test_cases/t00019_class.svg)
where the dependency relationships do not bring much information into the diagram. Thus in such cases it might
where the dependency relationships do not bring much information into the diagram. In such cases it might
be useful to disable dependency relationships for this diagram completely using the following exclusion filter:
```yaml
exclude: