Updated clang-uml diagrams

This commit is contained in:
Bartek Kryza
2024-03-06 17:53:29 +01:00
parent fdea7f5852
commit b8a649ff93
11 changed files with 72 additions and 5 deletions

View File

@@ -2,6 +2,7 @@ compilation_database_dir: debug
output_directory: docs/diagrams output_directory: docs/diagrams
comment_parser: clang comment_parser: clang
add_compile_flags: add_compile_flags:
- -fparse-all-comments
- -Wno-deprecated-declarations - -Wno-deprecated-declarations
remove_compile_flags: remove_compile_flags:
- -Wno-class-memaccess - -Wno-class-memaccess
@@ -37,7 +38,7 @@ diagrams:
include!: uml/class/stylable_element_hierarchy_class.yml include!: uml/class/stylable_element_hierarchy_class.yml
source_location_hierarchy_class: source_location_hierarchy_class:
include!: uml/class/source_location_hierarchy_class.yml include!: uml/class/source_location_hierarchy_class.yml
"filter_visitor_hierarchy_class": filter_visitor_hierarchy_class:
include!: uml/class/filter_visitor_hierarchy_class.yml include!: uml/class/filter_visitor_hierarchy_class.yml
diagram_filter_context_class: diagram_filter_context_class:
include!: uml/class/diagram_filter_context_class.yml include!: uml/class/diagram_filter_context_class.yml
@@ -76,6 +77,8 @@ diagrams:
include!: uml/sequence/diagram_generate_generic_sequence.yml include!: uml/sequence/diagram_generate_generic_sequence.yml
class_diagram_generator_sequence: class_diagram_generator_sequence:
include!: uml/sequence/class_diagram_generator_sequence.yml include!: uml/sequence/class_diagram_generator_sequence.yml
plantuml_sequence_diagram_generator_sequence:
include!: uml/sequence/plantuml_sequence_diagram_generator_sequence.yml
template_builder_sequence: template_builder_sequence:
include!: uml/sequence/template_builder_sequence.yml include!: uml/sequence/template_builder_sequence.yml
# Package diagrams # Package diagrams

View File

@@ -12,3 +12,8 @@ include:
exclude: exclude:
access: [ public, protected, private ] access: [ public, protected, private ]
relationships: [ dependency ] relationships: [ dependency ]
plantuml:
style:
inheritance: up
before:
- left to right direction

View File

@@ -13,5 +13,9 @@ include:
exclude: exclude:
relationships: relationships:
- dependency - dependency
access:
- public
- protected
- private
using_namespace: using_namespace:
- clanguml - clanguml

View File

@@ -23,4 +23,7 @@ exclude:
- private - private
- protected - protected
using_namespace: using_namespace:
- clanguml - clanguml
plantuml:
before:
- left to right direction

View File

@@ -2,10 +2,18 @@ type: sequence
title: PlantUML diagram generator sequence diagram title: PlantUML diagram generator sequence diagram
glob: glob:
- src/class_diagram/generators/plantuml/*.cc - src/class_diagram/generators/plantuml/*.cc
generate_condition_statements: true
generate_message_comments: true
include: include:
namespaces: namespaces:
- clanguml - clanguml
using_namespace: using_namespace:
- clanguml::class_diagram::generators::plantuml - clanguml::class_diagram::generators::plantuml
exclude:
elements:
- r: "clanguml::config::option.*"
- r: "clanguml::common::optional_ref.*"
namespaces:
- clanguml::util
from: from:
- function: "clanguml::common::generators::plantuml::generator<clanguml::config::class_diagram,clanguml::class_diagram::model::diagram>::generate(std::ostream &) const" - function: "clanguml::common::generators::plantuml::generator<clanguml::config::class_diagram,clanguml::class_diagram::model::diagram>::generate(std::ostream &) const"

View File

@@ -2,7 +2,8 @@ type: sequence
title: CLI options handling sequence diagram title: CLI options handling sequence diagram
combine_free_functions_into_file_participants: true combine_free_functions_into_file_participants: true
generate_method_arguments: none generate_method_arguments: none
debug_mode: true generate_condition_statements: true
generate_message_comments: true
glob: glob:
- src/cli/cli_handler.cc - src/cli/cli_handler.cc
- src/config/config.cc - src/config/config.cc
@@ -14,6 +15,7 @@ include:
exclude: exclude:
elements: elements:
- r: "clanguml::config::option.*" - r: "clanguml::config::option.*"
- "clanguml::config::config"
paths: paths:
- src/util/util.h - src/util/util.h
callee_types: callee_types:

View File

@@ -1,7 +1,9 @@
type: sequence type: sequence
title: Common sequence diagram generator sequence diagram title: PlantUML sequence diagram generator sequence diagram
combine_free_functions_into_file_participants: true combine_free_functions_into_file_participants: true
generate_method_arguments: none generate_method_arguments: none
generate_condition_statements: true
generate_message_comments: true
glob: glob:
- src/common/generators/generators.cc - src/common/generators/generators.cc
using_namespace: using_namespace:
@@ -10,6 +12,12 @@ include:
namespaces: namespaces:
- clanguml::common::generators - clanguml::common::generators
exclude: exclude:
elements:
- r: ".*json.*"
- r: ".*mermaid.*"
- r: ".*class_diagram.*"
- r: ".*package_diagram.*"
- r: ".*include_diagram.*"
paths: paths:
- src/common/model/source_location.h - src/common/model/source_location.h
from: from:

View File

@@ -2,6 +2,8 @@ type: sequence
title: Configuration file loading sequence diagram title: Configuration file loading sequence diagram
combine_free_functions_into_file_participants: true combine_free_functions_into_file_participants: true
generate_method_arguments: none generate_method_arguments: none
generate_condition_statements: true
generate_message_comments: true
glob: glob:
- src/config/config.cc - src/config/config.cc
- src/config/yaml_decoders.cc - src/config/yaml_decoders.cc

View File

@@ -4,6 +4,8 @@ title: main() function sequence diagram
combine_free_functions_into_file_participants: true combine_free_functions_into_file_participants: true
# Do not generate method or function arguments # Do not generate method or function arguments
generate_method_arguments: none generate_method_arguments: none
generate_condition_statements: true
generate_message_comments: true
# Parse only 1 translation unit for this diagram # Parse only 1 translation unit for this diagram
glob: glob:
- src/main.cc - src/main.cc

View File

@@ -0,0 +1,28 @@
type: sequence
title: PlantUML sequence diagram generator sequence diagram
combine_free_functions_into_file_participants: true
generate_method_arguments: none
generate_condition_statements: true
generate_message_comments: true
glob:
- src/sequence_diagram/generators/plantuml/sequence_diagram_generator.cc
using_namespace:
- clanguml
include:
namespaces:
- clanguml
elements:
- r: ".*generators.*"
exclude:
elements:
- r: ".*json.*"
- r: ".*mermaid.*"
- r: ".*class_diagram.*"
- r: ".*package_diagram.*"
- r: ".*include_diagram.*"
- r: "clanguml::config::option.*"
- r: "clanguml::common::optional_ref.*"
paths:
- src/common/model/source_location.h
from:
- function: "clanguml::sequence_diagram::generators::plantuml::generator::generate_diagram(std::ostream &) const"

View File

@@ -2,6 +2,8 @@ type: sequence
title: Diagram element template builder sequence diagram title: Diagram element template builder sequence diagram
combine_free_functions_into_file_participants: true combine_free_functions_into_file_participants: true
generate_method_arguments: none generate_method_arguments: none
generate_condition_statements: true
generate_message_comments: true
glob: glob:
- src/common/visitor/template_builder.cc - src/common/visitor/template_builder.cc
include: include:
@@ -16,4 +18,4 @@ exclude:
using_namespace: using_namespace:
- clanguml - clanguml
from: from:
- function: "clanguml::common::visitor::template_builder::build(common::model::template_element &,const clang::NamedDecl *,const clang::TemplateSpecializationType &,std::optional<common::model::template_element *>)" - function: "clanguml::common::visitor::template_builder<VisitorT>::build(common::model::template_element &,const clang::NamedDecl *,const clang::TemplateDecl *,const clang::ArrayRef<clang::TemplateArgument>,std::string,std::optional<common::model::template_element *>)"