matthias/clang-uml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added mapping table to README

Browse Source
This commit is contained in:
Bartek Kryza
2021-03-03 23:23:32 +01:00
parent 32961cb42e
commit decaf22b5f
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -5,12 +5,34 @@ YAML configuration files. The main idea behind the project is to easily
maintain up-to-date diagrams within a code-base. The configuration file or maintain up-to-date diagrams within a code-base. The configuration file or
files for clang-uml define the type and scope of each diagram. files for clang-uml define the type and scope of each diagram.
## Rationale
## Installation ## Installation
TODO TODO
## Usage ## Usage
### Invocation
### Configuration file format and examples
### Class diagrams
#### Default mappings
| UML | C++ |
| ---- | --- |
| Inheritance (A is kind of B) | Public, protected or private inheritance |
| Association (A knows of B) | Class A has a pointer or a reference to class B, or any container with a pointer or reference to B |
| Dependency (A uses B) | Any method of class A has argument of type B |
| Aggregation (A has B) | Class A has a field of type B or an owning pointer of type B |
| Composition (A has B) | Class A has a field of type container of B |
| Template (T specializes A) | Class A has a template parameter T |
| Nesting (A has inner class B)| Class B is an inner class of A
#### Inline directives
## Building ## Building
### Ubuntu ### Ubuntu