Added initial documentation
This commit is contained in:
15
docs/interactive_svg_diagrams.md
Normal file
15
docs/interactive_svg_diagrams.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Interactive SVG diagrams
|
||||
|
||||
`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:
|
||||
```yaml
|
||||
generate_links:
|
||||
link: 'https://github.com/myorg/myrepo/blob/{{ git.commit }}/{{ element.source.path }}#L{{ element.source.line }}'
|
||||
tooltip: '{% if "comment" in element %}{{ abbrv(trim(replace(element.comment, "\n+", " ")), 256) }}{% else %}{{ element.name }}{% endif %}'
|
||||
```
|
||||
|
||||
You can open example diagram [here](https://raw.githubusercontent.com/bkryza/clang-uml/master/docs/test_cases/t00014_class.svg) to see how it works in action.
|
||||
Reference in New Issue
Block a user