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

Added toc to each docs page and Makefile update target

Browse Source
This commit is contained in:
Bartek Kryza
2023-01-19 22:01:51 +01:00
parent c6bb063ef2
commit 9a527eef0c
18 changed files with 179 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/class_diagrams.md
View File

@@ -1,5 +1,18 @@
# Generating class diagrams
<!-- toc -->
* [Classes and their properties](#classes-and-their-properties)
* [Excluding private or protected members from the diagram](#excluding-private-or-protected-members-from-the-diagram)
* [Relationships](#relationships)
* [Relationships to classes in containers or smart pointers](#relationships-to-classes-in-containers-or-smart-pointers)
* [Inheritance diagrams](#inheritance-diagrams)
* [Namespaces as packages](#namespaces-as-packages)
* [Class context diagram](#class-context-diagram)
* [Disabling dependency relationships](#disabling-dependency-relationships)
<!-- tocstop -->
The minimal config required to generate a class diagram is presented below:
```yaml
# Path to the directory where `compile_commands.json` can be found