From decaf22b5ff0fb4af029a2877678eaed70bda1f3 Mon Sep 17 00:00:00 2001 From: Bartek Kryza Date: Wed, 3 Mar 2021 23:23:32 +0100 Subject: [PATCH] Added mapping table to README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index b2ff574d..58f8ec79 100644 --- a/README.md +++ b/README.md @@ -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 files for clang-uml define the type and scope of each diagram. +## Rationale + ## Installation TODO ## 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 ### Ubuntu