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

Updated configuration file docs

Browse Source
This commit is contained in:
Bartek Kryza
2022-02-16 22:03:25 +01:00
parent 1b65832e13
commit d50a45b033
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/configuration_file.md
View File

@@ -7,7 +7,7 @@
the key of the diagram YAML node the key of the diagram YAML node
### Diagram options ### Diagram options
* `type` - type of diagram, one of [`class`, `sequence`] * `type` - type of diagram, one of [`class`, `sequence`, `package`]
* `glob` - list of glob patterns to match source code files for analysis * `glob` - list of glob patterns to match source code files for analysis
* `include_relations_also_as_members` - when set to `false`, class members for relationships are rendered in UML are skipped from class definition (default: `true`) * `include_relations_also_as_members` - when set to `false`, class members for relationships are rendered in UML are skipped from class definition (default: `true`)
* `generate_method_arguments` - determines whether the class diagrams methods contain full arguments (`full`), are abbreviated (`abbreviated`) or skipped (`none`) * `generate_method_arguments` - determines whether the class diagrams methods contain full arguments (`full`), are abbreviated (`abbreviated`) or skipped (`none`)
@@ -22,6 +22,7 @@
* `relationships` - list of relationships to exclude * `relationships` - list of relationships to exclude
* `entity_types` - list of entity types to exclude (e.g. `class`, `enum`) * `entity_types` - list of entity types to exclude (e.g. `class`, `enum`)
* `scopes` - list of visibility scopes to exclude (e.g. `private`) * `scopes` - list of visibility scopes to exclude (e.g. `private`)
* `layout` - add layout hints for entities (classes, packages)
* `plantuml` - verbatim PlantUML directives which should be added to a diagram * `plantuml` - verbatim PlantUML directives which should be added to a diagram
* `before` - list of directives which will be added before the generated diagram * `before` - list of directives which will be added before the generated diagram
* `after` - list of directives which will be added after the generated diagram * `after` - list of directives which will be added after the generated diagram
@@ -61,6 +62,11 @@ diagrams:
# Do not include private members and methods in the diagram # Do not include private members and methods in the diagram
scopes: scopes:
- private - private
layout:
# Add layout hints for PlantUML
ClassA:
- up: ClassB
- left: ClassC
# Entities from this namespace will be shortened # Entities from this namespace will be shortened
# (can only contain one element at the moment) # (can only contain one element at the moment)
using_namespace: using_namespace: