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

Updated docs with Mermaid docs

Browse Source
This commit is contained in:
Bartek Kryza
2023-09-13 18:54:23 +02:00
parent 70e7088823
commit abd85534bc
15 changed files with 137 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/interactive_svg_diagrams.md
View File

@@ -6,12 +6,14 @@
<!-- tocstop -->
`clang-uml` in combination with PlantUML's link generation in diagrams allows to generate interactive diagrams,
where clicking on any class, method or call expression can direct the user directly to the source code or some other
`clang-uml` in combination with PlantUML's link generation in diagrams allows to
generate interactive diagrams, where clicking on any class, method or call
expression can direct the user directly to the source code or some other
diagram or document available online.
For instance to generate links to GitHub repository directly for most of diagram elements simple add this to your
`.clang-uml` file:
For instance to generate links to GitHub repository directly for most diagram
elements simple add this to your `.clang-uml` file:
```yaml
generate_links:
link: 'https://github.com/myorg/myrepo/blob/{{ git.commit }}/{{ element.source.path }}#L{{ element.source.line }}'