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

10
docs/sequence_diagrams.md
View File

@@ -1,5 +1,15 @@
# Generating sequence diagrams
<!-- toc -->
* [Sequence diagram overview](#sequence-diagram-overview)
* [Specifying diagram entry point](#specifying-diagram-entry-point)
* [Grouping free functions by file](#grouping-free-functions-by-file)
* [Lambda expressions in sequence diagrams](#lambda-expressions-in-sequence-diagrams)
* [Customizing participants order](#customizing-participants-order)
<!-- tocstop -->
The minimal config required to generate a sequence diagram is presented below:
```yaml
# Path to the directory where `compile_commands.json` can be found