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
2021-07-24 19:43:57 +02:00
parent ea8f0e83c1
commit d4659c829d
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/configuration_file.md
View File

@@ -9,6 +9,7 @@
### Diagram options ### Diagram options
* `type` - type of diagram, one of [`class`, `sequence`] * `type` - type of diagram, one of [`class`, `sequence`]
* `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`)
* `using_namespace` - similar to C++ `using namespace`, a `A::B` value here will render a class `A::B::C::MyClass` in the diagram as `C::MyClass` * `using_namespace` - similar to C++ `using namespace`, a `A::B` value here will render a class `A::B::C::MyClass` in the diagram as `C::MyClass`
* `include` - definition of inclusion patterns: * `include` - definition of inclusion patterns:
* `namespaces` - list of namespaces to include * `namespaces` - list of namespaces to include