Added initial Doxygen config

This commit is contained in:
Bartek Kryza
2023-06-18 01:18:14 +02:00
parent 031235bf49
commit da2cb63ab3
51 changed files with 4330 additions and 158 deletions

View File

@@ -0,0 +1,13 @@
type: sequence
glob:
- src/class_diagram/generators/plantuml/*.cc
include:
namespaces:
- clanguml
using_namespace:
- clanguml::class_diagram::generators::plantuml
plantuml:
before:
- 'title clang-uml clanguml::class_diagram::generators::plantuml::generator sequence diagram'
start_from:
- function: "clanguml::class_diagram::generators::plantuml::generator::generate(std::ostream &)"

View File

@@ -0,0 +1,20 @@
type: sequence
combine_free_functions_into_file_participants: true
generate_method_arguments: none
glob:
- src/cli/cli_handler.cc
- src/config/config.cc
- src/config/yaml_decoders.cc
include:
namespaces:
- clanguml
- YAML
exclude:
elements:
- r: "clanguml::config::option.*"
paths:
- src/util/util.h
using_namespace:
- clanguml
start_from:
- function: "clanguml::cli::cli_handler::handle_options(int,const char **)"

View File

@@ -0,0 +1,19 @@
type: sequence
combine_free_functions_into_file_participants: true
generate_method_arguments: none
glob:
- src/common/generators/generators.cc
using_namespace:
- clanguml
include:
namespaces:
- clang
- clanguml::common::generators
exclude:
namespaces:
- clanguml::model::tvl
- clanguml::decorators
paths:
- src/common/model/source_location.h
start_from:
- function: "clanguml::common::generators::generate_diagram(const std::string &,const std::string &,std::shared_ptr<clanguml::config::diagram>,const common::compilation_database &,const std::vector<std::string> &,const std::vector<clanguml::common::generator_type_t> &,bool,std::function<void ()> &&)"

View File

@@ -0,0 +1,19 @@
type: sequence
combine_free_functions_into_file_participants: true
generate_method_arguments: none
glob:
- src/config/config.cc
- src/config/yaml_decoders.cc
include:
namespaces:
- clanguml
- YAML
exclude:
elements:
- r: "clanguml::config::option.*"
paths:
- src/util/util.h
using_namespace:
- clanguml
start_from:
- function: "clanguml::config::load(const std::string &,std::optional<bool>,std::optional<bool>)"

View File

@@ -0,0 +1,27 @@
type: sequence
# Group free functions into one participant per file
combine_free_functions_into_file_participants: true
# Do not generate method or function arguments
generate_method_arguments: none
# Parse only 1 translation unit for this diagram
glob:
- src/main.cc
include:
# Only include entities and call expressions from the project directory
paths:
- src
exclude:
# Exclude calls to config options
elements:
- clanguml::config::option<std::string>
# Exclude entities and call expressions from irrelevant files
paths:
- src/util/util.h
using_namespace:
- clanguml
plantuml:
before:
- 'title clang-uml main function sequence diagram'
# Use clang-uml main function as entry point for this diagram
start_from:
- function: main(int,const char **)

View File

@@ -0,0 +1,28 @@
type: sequence
# Group free functions into one participant per file
combine_free_functions_into_file_participants: true
# Do not generate method or function arguments
generate_method_arguments: none
glob:
- src/sequence_diagram/visitor/*.cc
- src/sequence_diagram/model/*.cc
- src/common/visitor/*.cc
- src/common/model/*.cc
include:
namespaces:
- clanguml
paths:
- .
exclude:
namespaces:
- clanguml::model::tvl
- clanguml::decorators
paths:
- src/common/model/source_location.h
using_namespace:
- clanguml
plantuml:
before:
- 'title clang-uml sequence_diagram::visitor::translation_unit_visitor::VisitCXXRecordDecl sequence diagram'
start_from:
- function: "clanguml::sequence_diagram::visitor::translation_unit_visitor::VisitCXXRecordDecl(clang::CXXRecordDecl *)"

View File

@@ -0,0 +1,21 @@
type: sequence
combine_free_functions_into_file_participants: true
generate_method_arguments: none
glob:
- src/class_diagram/visitor/template_builder.cc
include:
namespaces:
- clanguml
paths:
- src/class_diagram/visitor/template_builder.h
- src/class_diagram/visitor/template_builder.cc
exclude:
paths:
- src/common/model/source_location.h
using_namespace:
- clanguml
plantuml:
before:
- 'title clang-uml class_diagram::visitor::template_builder::build sequence diagram'
start_from:
- function: "clanguml::class_diagram::visitor::template_builder::build(const clang::NamedDecl *,const clang::TemplateSpecializationType &,std::optional<class_diagram::model::class_ *>)"