Added Doxygen documentation

This commit is contained in:
Bartek Kryza
2023-06-23 19:38:28 +02:00
parent a39af67987
commit d8ef12d1c6
16 changed files with 1063 additions and 39 deletions

View File

@@ -0,0 +1,16 @@
type: class
generate_packages: true
glob:
- src/docs/architecture.cc
include:
namespaces:
- clanguml
elements:
- r: "clanguml::.+::translation_unit_visitor.*"
- r: "clanguml::.+::model::diagram"
exclude:
access: [ public, protected, private ]
relationships: [ dependency ]
plantuml:
before:
- title clang-uml top level architecture - AST visitors

View File

@@ -8,8 +8,15 @@ include:
exclude:
relationships:
- dependency
subclasses:
- clanguml::common::model::filter_visitor
access: [public, protected, private]
element_types:
- enum
using_namespace:
- clanguml::common::model
plantuml:
before:
- 'title clang-uml common diagram model'
- 'title clang-uml common diagram model'
after:
- 'note top of {{ alias("diagram") }}: Common class for specific diagram types'

View File

@@ -1,12 +1,26 @@
type: class
include_relations_also_as_members: false
include_relations_also_as_members: true
glob:
- src/config/config.cc
include:
namespaces:
- clanguml::config
context:
- clanguml::config::inheritable_diagram_options
- clanguml::config::config
- clanguml::config::diagram
exclude:
elements:
- r: "clanguml::config::option<.*>"
using_namespace:
- clanguml::config
plantuml:
before:
- 'title clang-uml configuration model'
- 'title clang-uml configuration model'
after:
- 'note left of {{ alias("inheritable_diagram_options") }}: Options common to all diagram types.'
- 'note right of {{ alias("config") }}: General options not used by diagrams.'
- 'note bottom of {{ alias("class_diagram") }}: Options for specific class diagrams'
- 'note bottom of {{ alias("sequence_diagram") }}: Options for specific sequence diagrams'
- 'note bottom of {{ alias("package_diagram") }}: Options for specific package diagrams'
- 'note bottom of {{ alias("include_diagram") }}: Options for specific include diagrams'

View File

@@ -1,6 +1,6 @@
type: class
include_relations_also_as_members: true
generate_packages: true
generate_packages: false
glob:
- src/common/model/diagram_filter.cc
- src/common/model/diagram.cc
@@ -12,5 +12,9 @@ include:
exclude:
elements:
- clanguml::common::model::path
method_types:
- constructor
- destructor
- operator
using_namespace:
- clanguml