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

Updated docs links

Browse Source
This commit is contained in:
Bartek Kryza
2023-06-23 19:54:30 +02:00
parent 321fb177a9
commit 525b3f74a6
2 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@@ -142,7 +142,7 @@ docs:
doxygen: docs doxygen: docs
cp CONTRIBUTING.md docs/contributing.md cp CONTRIBUTING.md docs/contributing.md
cp CHANGELOG.md docs/changelog.md cp CHANGELOG.md docs/changelog.md
cp docs/diagrams/*.svg docs/doxygen/ cp docs/diagrams/*.svg docs/doxygen/html/
mkdir -p docs/doxygen/html/test_cases mkdir -p docs/doxygen/html/test_cases
cp docs/test_cases/*.svg docs/doxygen/html/test_cases/ cp docs/test_cases/*.svg docs/doxygen/html/test_cases/
../doxygen/_build/bin/doxygen ../doxygen/_build/bin/doxygen

5
README.md
View File

@@ -6,6 +6,7 @@
[![Coverage](https://codecov.io/gh/bkryza/clang-uml/branch/master/graph/badge.svg)](https://codecov.io/gh/bkryza/clang-uml) [![Coverage](https://codecov.io/gh/bkryza/clang-uml/branch/master/graph/badge.svg)](https://codecov.io/gh/bkryza/clang-uml)
[![Version](https://img.shields.io/badge/version-0.3.7-blue)](https://github.com/bkryza/clang-uml/releases) [![Version](https://img.shields.io/badge/version-0.3.7-blue)](https://github.com/bkryza/clang-uml/releases)
[![Version](https://img.shields.io/badge/LLVM-12,13,14,15,16-orange)](https://github.com/bkryza/clang-uml/releases) [![Version](https://img.shields.io/badge/LLVM-12,13,14,15,16-orange)](https://github.com/bkryza/clang-uml/releases)
[![Doxygen](https://img.shields.io/badge/Docs-Doxygen-gainsboro)](https://clanguml-uml.github.io)
`clang-uml` is an automatic C++ to UML class, sequence, package and include diagram generator, driven by `clang-uml` is an automatic C++ to UML class, sequence, package and include diagram generator, driven by
YAML configuration files. The main idea behind the YAML configuration files. The main idea behind the
@@ -16,7 +17,7 @@ The diagrams can be generated in [PlantUML](https://plantuml.com) and JSON forma
`clang-uml` currently supports C++ up to version 17 with partial support for C++ 20. `clang-uml` currently supports C++ up to version 17 with partial support for C++ 20.
Full documentation can be found [here](./docs/README.md). Full documentation can be found at [clanguml-uml.github.io](https://clanguml-uml.github.io).
To see what `clang-uml` can do, checkout the diagrams generated for unit To see what `clang-uml` can do, checkout the diagrams generated for unit
test cases [here](./docs/test_cases.md) or examples in test cases [here](./docs/test_cases.md) or examples in
@@ -55,7 +56,7 @@ Main features supported so far include:
* **Include graph diagram generation** * **Include graph diagram generation**
* Show include graph for selected files - [_example_](docs/test_cases/t40001.md) * Show include graph for selected files - [_example_](docs/test_cases/t40001.md)
More comprehensive documentation can be found [here](./docs/README.md). More comprehensive documentation can be at [clanguml-uml.github.io](https://clanguml-uml.github.io).
## Installation ## Installation