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

9
docs/common_options.md
View File

@@ -1,5 +1,14 @@
# Common diagram generation options
<!-- toc -->
* [Overall configuration file structure](#overall-configuration-file-structure)
* [Translation unit glob patterns](#translation-unit-glob-patterns)
* [PlantUML custom directives](#plantuml-custom-directives)
* [Adding debug information in the generated diagrams](#adding-debug-information-in-the-generated-diagrams)
<!-- tocstop -->
## Overall configuration file structure
By default, `clang-uml` will look for file `.clang-uml` in the projects directory and read all diagrams definitions
from it. The file must be specified in YAML and it's overall structure is as follows: