Files
clang-uml/docs/interactive_svg_diagrams.md
2023-01-19 22:01:51 +01:00

909 B

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:

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 to see how it works in action.