mirror of
https://github.com/bkryza/clang-uml.git
synced 2025-05-16 10:42:22 +08:00
116 lines
5.3 KiB
Markdown
116 lines
5.3 KiB
Markdown
# Configuration file reference
|
|
|
|
<!-- toc -->
|
|
|
|
* [Top level options](#top-level-options)
|
|
* [Diagram options](#diagram-options)
|
|
* [Example complete config](#example-complete-config)
|
|
|
|
<!-- tocstop -->
|
|
|
|
## Top level options
|
|
* `compilation_database_dir` - path to the directory containing `compile_commands.json`
|
|
* `output_directory` - path to the directory where PlantUML diagrams will be generated
|
|
* `diagrams` - the map of diagrams to be generated, each diagram name is provided as
|
|
the key of the diagram YAML node
|
|
* `debug_mode` - add inline debug information in the generated diagrams
|
|
|
|
### Diagram options
|
|
* `type` - type of diagram, one of [`class`, `sequence`, `package`, `include`]
|
|
* `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`)
|
|
* `generate_method_arguments` - determines whether the class diagrams methods contain full arguments (`full`), are abbreviated (`abbreviated`) or skipped (`none`)
|
|
* `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`, at most 1 value is supported
|
|
* `include` - definition of inclusion patterns:
|
|
* `namespaces` - list of namespaces to include
|
|
* `relationships` - list of relationships to include
|
|
* `elements` - list of elements, i.e. specific classes, enums, templates to include
|
|
* `access` - list of visibility scopes to include (e.g. `private`)
|
|
* `subclasses` - include only subclasses of specified classes (and themselves)
|
|
* `specializations` - include all specializations or instantiations of a given template
|
|
* `dependants` - include all classes, which depend on the specified class
|
|
* `dependencies` - include all classes, which are dependencies of the specified class
|
|
* `context` - include only entities in direct relationship with specified classes
|
|
* `exclude` - definition of exclusion patterns:
|
|
* `namespaces` - list of namespaces to exclude
|
|
* `relationships` - list of relationships to exclude
|
|
* `elements` - list of elements, i.e. specific classes, enums, templates to exclude
|
|
* `access` - list of visibility scopes to exclude (e.g. `private`)
|
|
* `subclasses` - exclude subclasses of specified classes (and themselves)
|
|
* `specializations` - exclude all specializations or instantiations of a given template
|
|
* `dependants` - exclude all classes, which depend on the specified class
|
|
* `dependencies` - exclude all classes, which are dependencies of the specified class
|
|
* `context` - exclude only entities in direct relationship with specified classes
|
|
* `layout` - add layout hints for entities (classes, packages)
|
|
* `plantuml` - verbatim PlantUML directives which should be added to a 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
|
|
|
|
## Example complete config
|
|
|
|
```yaml
|
|
# Directory containing the compile_commands.json file
|
|
compilation_database_dir: debug
|
|
# The directory where *.puml files will be generated
|
|
output_directory: docs/diagrams
|
|
# Set this as default for all diagrams
|
|
generate_method_arguments: none
|
|
# Enable generation of hyperlinks to diagram elements
|
|
generate_links:
|
|
# Link pattern
|
|
link: "https://github.com/bkryza/clang-uml/blob/{{ git.commit }}/{{ element.source.path }}#L{{ element.source.line }}"
|
|
# Tooltip pattern
|
|
tooltip: "{{ element.name }}"
|
|
# The map of diagrams - keys are also diagram file names
|
|
diagrams:
|
|
main_package:
|
|
# Include this diagram definition from a separate file
|
|
include!: uml/main_package_diagram.yml
|
|
config_class:
|
|
type: class
|
|
# Do not include rendered relations in the class box
|
|
include_relations_also_as_members: false
|
|
# Limiting the number of files to include can significantly
|
|
# improve the generation time
|
|
glob:
|
|
- src/common/model/*.h
|
|
- src/common/model/*.cc
|
|
- src/class_diagram/model/*.h
|
|
- src/class_diagram/model/*.cc
|
|
include:
|
|
# Only include entities from the following namespaces
|
|
namespaces:
|
|
- clanguml::common::model
|
|
- clanguml::class_diagram::model
|
|
# Only include elements in direct relationship with ClassA
|
|
context:
|
|
- ClassA
|
|
exclude:
|
|
# Do not include private members and methods in the diagram
|
|
access:
|
|
- private
|
|
layout:
|
|
# Add layout hints for PlantUML
|
|
ClassA:
|
|
- up: ClassB
|
|
- left: ClassC
|
|
# Specify customized relationship hints for types which are
|
|
# arguments in template instantiations
|
|
relationship_hints:
|
|
# All tuple arguments should be treated as aggregation
|
|
std::tuple: aggregation
|
|
# All some_template arguments should be treated as associations
|
|
# except for arguments with indexes 2 and 10
|
|
ns1::n2::some_template:
|
|
default: association
|
|
2: composition
|
|
10: aggregation
|
|
# Entities from this namespace will be shortened
|
|
# (can only contain one element at the moment)
|
|
using_namespace:
|
|
- clanguml::class_diagram::model
|
|
plantuml:
|
|
# Add this line to the beginning of the resulting puml file
|
|
before:
|
|
- 'title clang-uml class diagram model'
|
|
``` |