googol/clang-uml
1
0
Fork 0
mirror of https://github.com/bkryza/clang-uml.git synced 2025-05-16 10:42:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated configuration file specification

Browse Source
This commit is contained in:
Bartek Kryza 2023-05-06 00:14:26 +02:00
parent 2367765d1f
commit 4477a1892f
No known key found for this signature in database
GPG Key ID: 6CDA4566635E93B1
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/configuration_file.md
View File

@ -16,6 +16,8 @@
* `diagrams` - the map of diagrams to be generated, each diagram name is provided as * `diagrams` - the map of diagrams to be generated, each diagram name is provided as
the key of the diagram YAML node the key of the diagram YAML node
* `debug_mode` - add inline debug information in the generated diagrams * `debug_mode` - add inline debug information in the generated diagrams
* `add_compile_flags` - add compile flags to all compilation database entries
* `remove_compile_flags` - remove compile flags from all compilation database entries
### Diagram options ### Diagram options
* `type` - type of diagram, one of [`class`, `sequence`, `package`, `include`] * `type` - type of diagram, one of [`class`, `sequence`, `package`, `include`]
@ -56,6 +58,9 @@ compilation_database_dir: debug
# Inject additional compile commands to the compilation database entries # Inject additional compile commands to the compilation database entries
add_compile_flags: add_compile_flags:
- '-Wno-vla-extension' - '-Wno-vla-extension'
# Remove specified compile flags from all compilation database entries
remove_compile_flags:
- '-Wshadow'
# The directory where *.puml files will be generated # The directory where *.puml files will be generated
output_directory: docs/diagrams output_directory: docs/diagrams
# Set this as default for all diagrams # Set this as default for all diagrams