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

Improved docs (#208)

Browse Source
This commit is contained in:
Bartek Kryza
2023-12-10 21:10:51 +01:00
parent c0faeccff9
commit da6001728b
21 changed files with 173 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/architecture.md
View File

@@ -27,7 +27,7 @@ This section presents general architecture and components of `clang-uml`.
uses [Clang LibTooling API](https://releases.llvm.org/16.0.0/tools/clang/docs/LibTooling.html)
to traverse
the AST (Abstract Syntax Tree) of the source code and extract any information
relevant for a specified diagram.
relevant for a specific diagram.
The code is divided into several packages (namespaces), the main of them are:
@@ -131,11 +131,7 @@ generator.
## Diagram generators
Diagram generators convert the `clang-uml`'s internal UML model into actual
diagram in one of the supported formats:
- PlantUML
- MermaidJS
- JSON
diagram in one of the supported formats: PlantUML, MermaidJS and JSON.
Each diagram generator extends a common interface appropriate for the
selected output format, i.e.: