Detailed Description

Definition at line 196 of file config.h.

#include <config.h>

Public Attributes
std::shared_ptr< filter >	anyof

std::shared_ptr< filter >	allof

std::vector< common::namespace_or_regex >	namespaces
	Namespaces filter.

std::vector< common::string_or_regex >	modules
	Modules filter.

std::vector< common::model::module_access_t >	module_access
	Access type filter.

std::vector< common::string_or_regex >	elements
	Elements filter.

std::vector< std::string >	element_types
	Element types filter.

std::vector< common::model::relationship_t >	relationships
	Relationships filter.

std::vector< common::model::access_t >	access
	Access type filter.

std::vector< common::string_or_regex >	subclasses
	Subclasses filter.

std::vector< common::string_or_regex >	parents
	Parents filter.

std::vector< common::string_or_regex >	specializations
	Specializations filter.

std::vector< common::string_or_regex >	dependants
	Dependants filter.

std::vector< common::string_or_regex >	dependencies
	Dependencies filter.

std::vector< context_config >	context
	Context filter.

std::vector< std::string >	paths
	Paths filter.

std::vector< method_type >	method_types
	Method types filter.

std::vector< callee_type >	callee_types
	Callee types filter.

Member Data Documentation

◆ access

std::vector<common::model::access_t> clanguml::config::filter::access

Access type filter.

This filter allows to filter class members methods based on their access:

public
protected
private

Example:

include:
  access:
    - public

Definition at line 297 of file config.h.

◆ allof

std::shared_ptr<filter> clanguml::config::filter::allof

Definition at line 198 of file config.h.

◆ anyof

std::shared_ptr<filter> clanguml::config::filter::anyof

Definition at line 197 of file config.h.

◆ callee_types

std::vector<callee_type> clanguml::config::filter::callee_types

Callee types filter.

This filter allows to filter sequence diagram calls by callee types.

See also: method_type

Example:

exclude:
  callee_types:
    - constructor
    - operator

Definition at line 443 of file config.h.

◆ context

std::vector<context_config> clanguml::config::filter::context

Context filter.

This filter allows to filter classes based on whether they have at least one direct relation to the specified class.

Example:

include:
  context:
    - ns1::ns2::ClassA
    - r: ns1::ns2::ClassB<.*>
    - match:
        pattern: ns1::ns2::ClassA
        radius: 3

Definition at line 393 of file config.h.

◆ dependants

std::vector<common::string_or_regex> clanguml::config::filter::dependants

Dependants filter.

This filter allows to filter classes based on whether they are a dependant on a specified class.

Example:

include:
  dependants:
    - ns1::ns2::ClassA

Definition at line 359 of file config.h.

◆ dependencies

std::vector<common::string_or_regex> clanguml::config::filter::dependencies

Dependencies filter.

This filter allows to filter classes based on whether they are a dependency of a specified class.

Example:

include:
  dependencies:
    - ns1::ns2::ClassA

Definition at line 374 of file config.h.

◆ element_types

std::vector<std::string> clanguml::config::filter::element_types

Element types filter.

This filter allows to filter diagram elements based on their type.

include:
  elements:
    - class
    - concept

Definition at line 266 of file config.h.

◆ elements

std::vector<common::string_or_regex> clanguml::config::filter::elements

Elements filter.

Example:

exclude:
  elements:
    - ns1::ns2::ClassA
    - r: ".*Enum.*"

Definition at line 253 of file config.h.

◆ method_types

std::vector<method_type> clanguml::config::filter::method_types

Method types filter.

This filter allows to filter class methods based on their category.

See also: method_type

Example:

exclude:
  method_types:
    - constructor
    - operator
    - assignment

Definition at line 426 of file config.h.

◆ module_access

std::vector<common::model::module_access_t> clanguml::config::filter::module_access

Access type filter.

This filter allows to filter class members methods based on their access:

public
private

Example:

include:
  module_access:
    - public

Definition at line 240 of file config.h.

◆ modules

std::vector<common::string_or_regex> clanguml::config::filter::modules

Modules filter.

Example:

include
  modules:
    - app.module1
    - r: ".*internal.*"

Definition at line 224 of file config.h.

◆ namespaces

std::vector<common::namespace_or_regex> clanguml::config::filter::namespaces

Namespaces filter.

Example:

include
  namespaces:
    - ns1::ns2
    - r: ".*detail.*"

Definition at line 211 of file config.h.

◆ parents

std::vector<common::string_or_regex> clanguml::config::filter::parents

Parents filter.

This filter allows to filter classes based on being a base class of a specified child. This filter also matches the specified child itself.

Example:

include:
  parents:
    - ns1::ns2::ChildA

Definition at line 328 of file config.h.

◆ paths

std::vector<std::string> clanguml::config::filter::paths

Paths filter.

This filter allows to filter diagram elements based on the source location of their declaration.

Example:

include:
  context:
    - ns1::ns2::ClassA

Definition at line 408 of file config.h.

◆ relationships

std::vector<common::model::relationship_t> clanguml::config::filter::relationships

Relationships filter.

This filter allows to filter relationships included in the diagram.

Example:

include:
  relationships:
    - inheritance

Definition at line 280 of file config.h.

◆ specializations

std::vector<common::string_or_regex> clanguml::config::filter::specializations

Specializations filter.

This filter allows to filter class template specializations of a specific template. This filter also matches the specified template itself.

Example:

include:
  specializations:
    - ns1::ns2::ClassA<int,T>

Definition at line 344 of file config.h.

◆ subclasses

std::vector<common::string_or_regex> clanguml::config::filter::subclasses

Subclasses filter.

This filter allows to filter classes based on having a specified parent. This filter also matches the specified parent itself.

Example:

include:
  subclasses:
    - ns1::ns2::ClassA

Definition at line 312 of file config.h.

The documentation for this struct was generated from the following file:

src/config/config.h

Detailed Description

Public Attributes

Member Data Documentation

◆ access

◆ allof

◆ anyof

◆ callee_types

◆ context

◆ dependants

◆ dependencies

◆ element_types

◆ elements

◆ method_types

◆ module_access

◆ modules

◆ namespaces

◆ parents

◆ paths

◆ relationships

◆ specializations

◆ subclasses