Class diagram configuration. More...

Detailed Description

Class diagram configuration.

Definition at line 694 of file config.h.

#include <config.h>

Public Member Functions
	~class_diagram () override=default

common::model::diagram_t	type () const override

void	initialize_relationship_hints ()

Public Member Functions inherited from clanguml::config::diagram
	~diagram () override=default

virtual common::model::diagram_t	type () const =0

std::vector< std::string >	glob_translation_units (const std::vector< std::string > &compilation_database_files) const
	Filter translation units based on glob patterns.

std::filesystem::path	make_path_relative (const std::filesystem::path &p) const
	Make path relative to the `relative_to` config option.

std::vector< std::string >	make_module_relative (const std::optional< std::string > &maybe_module) const
	Make module path relative to `using_module` configuration option.

std::filesystem::path	root_directory () const
	Returns absolute path of the `relative_to` option.

std::optional< std::string >	get_together_group (const std::string &full_name) const

void	initialize_type_aliases ()
	Initialize predefined set of C++ type aliases.

Public Member Functions inherited from clanguml::config::inheritable_diagram_options
virtual	~inheritable_diagram_options ()=default

void	inherit (const inheritable_diagram_options &parent)

std::string	simplify_template_type (std::string full_name) const

bool	generate_fully_qualified_name () const
	Whether the diagram element should be fully qualified in diagram.

option< std::filesystem::path > &	get_relative_to ()
	Get reference to `relative_to` diagram config option.

Additional Inherited Members
Public Attributes inherited from clanguml::config::diagram
std::string	name

option< std::string >	title {"title"}

Public Attributes inherited from clanguml::config::inheritable_diagram_options
option< std::vector< common::string_or_regex > >	glob {"glob"}

option< common::model::namespace_ >	using_namespace {"using_namespace"}

option< std::string >	using_module {"using_module"}

option< bool >	include_relations_also_as_members

option< filter_mode_t >	filter_mode {"filter_mode", filter_mode_t::basic}

option< bool >	include_system_headers {"include_system_headers", false}

option< filter >	include {"include"}

option< filter >	exclude {"exclude"}

option< plantuml >	puml {"plantuml", option_inherit_mode::kAppend}

option< struct mermaid >	mermaid {"mermaid", option_inherit_mode::kAppend}

option< method_arguments >	generate_method_arguments

option< bool >	generate_concept_requirements

option< bool >	group_methods {"group_methods", true}

option< member_order_t >	member_order

option< bool >	generate_packages {"generate_packages", false}

option< package_type_t >	package_type

option< bool >	generate_template_argument_dependencies

option< bool >	skip_redundant_dependencies

option< generate_links_config >	generate_links {"generate_links"}

option< git_config >	git {"git"}

option< layout_hints >	layout {"layout"}

option< std::filesystem::path >	base_directory {"__parent_path"}

option< bool >	generate_system_headers {"generate_system_headers", false}

option< relationship_hints_t >	relationship_hints {"relationship_hints"}

option< type_aliases_t >	type_aliases

option< comment_parser_t >	comment_parser

option< bool >	combine_free_functions_into_file_participants

option< bool >	inline_lambda_messages {"inline_lambda_messages", false}

option< bool >	generate_return_types {"generate_return_types", false}

option< bool >	generate_condition_statements

option< std::vector< std::string > >	participants_order {"participants_order"}

option< bool >	generate_message_comments {"generate_message_comments", false}

option< unsigned >	message_comment_width

option< bool >	debug_mode {"debug_mode", false}

option< bool >	generate_metadata {"generate_metadata", true}

option< bool >	allow_empty_diagrams {"allow_empty_diagrams", false}

Protected Attributes inherited from clanguml::config::inheritable_diagram_options
option< std::filesystem::path >	relative_to {"relative_to"}

Constructor & Destructor Documentation

◆ ~class_diagram()

clanguml::config::class_diagram::~class_diagram ( )

overridedefault

Member Function Documentation

◆ initialize_relationship_hints()

void clanguml::config::class_diagram::initialize_relationship_hints ( )

Definition at line 475 of file config.cc.

{
    using common::model::relationship_t;
 
    if (relationship_hints().count("std::vector") == 0U) {
        relationship_hints().insert({"std::vector", {}});
    }
    if (relationship_hints().count("std::unique_ptr") == 0U) {
        relationship_hints().insert({"std::unique_ptr", {}});
    }
    if (relationship_hints().count("std::shared_ptr") == 0U) {
        relationship_hints().insert(
            {"std::shared_ptr", {relationship_t::kAssociation}});
    }
    if (relationship_hints().count("std::weak_ptr") == 0U) {
        relationship_hints().insert(
            {"std::weak_ptr", {relationship_t::kAssociation}});
    }
    if (relationship_hints().count("std::tuple") == 0U) {
        relationship_hints().insert({"std::tuple", {}});
    }
    if (relationship_hints().count("std::map") == 0U) {
        relationship_hint_t hint{relationship_t::kNone};
        hint.argument_hints.insert({1, relationship_t::kAggregation});
        relationship_hints().insert({"std::tuple", std::move(hint)});
    }
}

◆ type()

common::model::diagram_t clanguml::config::class_diagram::type ( ) const

overridevirtual

Implements clanguml::config::diagram.

Definition at line 455 of file config.cc.

{
    return common::model::diagram_t::kClass;
}

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

src/config/config.h
src/config/config.cc