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

Updated docs

Browse Source
This commit is contained in:
Bartek Kryza
2022-03-20 23:41:59 +01:00
parent cc839f88fd
commit ae4f073cce
3 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.clang-uml
View File

@@ -1,5 +1,8 @@
compilation_database_dir: debug compilation_database_dir: debug
output_directory: docs/diagrams output_directory: docs/diagrams
generate_links:
link: "https://github.com/bkryza/clang-uml/blob/{{ git.commit }}/{{ element.source.path }}#L{{ element.source.line }}"
tooltip: "{{ element.name }}"
diagrams: diagrams:
main_package: main_package:
include!: uml/main_package_diagram.yml include!: uml/main_package_diagram.yml

6
README.md
View File

@@ -18,10 +18,12 @@ Main features supported so far include:
* Relationship inference from C++ containers and smart pointers * Relationship inference from C++ containers and smart pointers
* Namespace based content filtering * Namespace based content filtering
* Optional package generation from namespaces * Optional package generation from namespaces
* Interactive links to online code to classes, methods and class fields
* Sequence diagram generation * Sequence diagram generation
* Generation of sequence diagram from one code location to another (currently only for non-template code) * Generation of sequence diagram from one code location to another (currently only for non-template code)
* Package diagram generation * Package diagram generation
* Generation of package diagram based on C++ namespaces * Generation of package diagram based on C++ namespaces
* Interactive links to online code to packages
To see what `clang-uml` can do so far, checkout the diagrams generated for unit test cases [here](./docs/test_cases.md). To see what `clang-uml` can do so far, checkout the diagrams generated for unit test cases [here](./docs/test_cases.md).
@@ -164,6 +166,9 @@ generates the following diagram (via PlantUML):
![class_diagram_example](docs/test_cases/t00009_class.svg) ![class_diagram_example](docs/test_cases/t00009_class.svg)
> Open the raw image [here](https://raw.githubusercontent.com/bkryza/clang-uml/master/docs/test_cases/t00009_class.svg),
> and checkout the hover tooltips and hyperlinks to classes and methods.
#### Default mappings #### Default mappings
| UML | C++ | | UML | C++ |
@@ -342,6 +347,7 @@ This project relies on the following great tools:
* [Catch2](https://github.com/catchorg/Catch2) - C++ unit test framework * [Catch2](https://github.com/catchorg/Catch2) - C++ unit test framework
* [glob](https://github.com/p-ranav/glob) - Unix style path expansion for C++ * [glob](https://github.com/p-ranav/glob) - Unix style path expansion for C++
* [CLI11](https://github.com/CLIUtils/CLI11) - command line parser for C++ * [CLI11](https://github.com/CLIUtils/CLI11) - command line parser for C++
* [inja](https://github.com/pantor/inja) - a template engine for modern C++
## LICENSE ## LICENSE

6
docs/configuration_file.md
View File

@@ -37,6 +37,12 @@ compilation_database_dir: debug
output_directory: docs/diagrams output_directory: docs/diagrams
# Set this as default for all diagrams # Set this as default for all diagrams
generate_method_arguments: none generate_method_arguments: none
# Enable generation of hyperlinks to diagram elements
generate_links:
# Link pattern
link: "https://github.com/bkryza/clang-uml/blob/{{ git.commit }}/{{ element.source.path }}#L{{ element.source.line }}"
# Tooltip pattern
tooltip: "{{ element.name }}"
# The map of diagrams - keys are also diagram file names # The map of diagrams - keys are also diagram file names
diagrams: diagrams:
main_package: main_package: