From 2c5769982b1fc5cec37d6d5f00166f0acf6dc305 Mon Sep 17 00:00:00 2001 From: Bartek Kryza Date: Wed, 3 May 2023 23:15:10 +0200 Subject: [PATCH] Updated README formatting --- README.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 585c0905..c6a7fef6 100644 --- a/README.md +++ b/README.md @@ -23,31 +23,31 @@ Full documentation can be found [here](./docs/README.md). Main features supported so far include: * **Class diagram generation** - * Class properties and methods including access [example](docs/test_cases/t00003.md) - * Class inheritance [example](docs/test_cases/t00002.md) - * Other class relationships including associations, aggregations, dependencies and friendship [example](docs/test_cases/t00006.md) - * Template instantiation relationships [example](docs/test_cases/t00014.md) - * Template specialization and instantiation based on deduced context [example](docs/test_cases/t00062.md) - * Relationship inference from C++ containers and smart pointers [example](docs/test_cases/t00007.md) - * Diagram content filtering based on namespaces, elements and relationships [example](docs/test_cases/t00040.md) - * Optional package generation from namespaces [example](docs/test_cases/t00036.md) + * Class properties and methods including access - [_example_](docs/test_cases/t00003.md) + * Class inheritance - [_example_](docs/test_cases/t00002.md) + * Other class relationships including associations, aggregations, dependencies and friendship - [_example_](docs/test_cases/t00006.md) + * Template instantiation relationships - [_example_](docs/test_cases/t00014.md) + * Template specialization and instantiation based on deduced context - [_example_](docs/test_cases/t00062.md) + * Relationship inference from C++ containers and smart pointers - [_example_](docs/test_cases/t00007.md) + * Diagram content filtering based on namespaces, elements and relationships - [_example_](docs/test_cases/t00040.md) + * Optional package generation from namespaces - [_example_](docs/test_cases/t00036.md) * Interactive links to online code to classes, methods and class fields in SVG diagrams - * Support for plain C99/C11 code (struct and units relationships) [example](docs/test_cases/t00057.md) - * C++20 concept constraints [example](docs/test_cases/t00059.md) + * Support for plain C99/C11 code (struct and units relationships) - [_example_](docs/test_cases/t00057.md) + * C++20 concept constraints - [_example_](docs/test_cases/t00059.md) * **Sequence diagram generation** - * Generation of sequence diagram from specific method or function [example](docs/test_cases/t00002.md) - * Generation of loop and conditional statements [example](docs/test_cases/t20021.md) - * Generation of switch statements [example](docs/test_cases/t20024.md) - * Generation of try/catch blocks [example](docs/test_cases/t20023.md) - * Handling of template code including constexpr conditionals [example](docs/test_cases/t20018.md) - * Handling of lambda expressions [example](docs/test_cases/t20012.md) + * Generation of sequence diagram from specific method or function - [_example_](docs/test_cases/t00002.md) + * Generation of loop and conditional statements - [_example_](docs/test_cases/t20021.md) + * Generation of switch statements - [_example_](docs/test_cases/t20024.md) + * Generation of try/catch blocks - [_example_](docs/test_cases/t20023.md) + * Handling of template code including constexpr conditionals - [_example_](docs/test_cases/t20018.md) + * Handling of lambda expressions - [_example_](docs/test_cases/t20012.md) * Interactive links to online code to classes and call expressions * **Package diagram generation** - * Generation of package diagram based on C++ namespaces [example](docs/test_cases/t30001.md) - * Dependencies between packages based on symbols used in the code [example](docs/test_cases/t30002.md) + * Generation of package diagram based on C++ namespaces - [_example_](docs/test_cases/t30001.md) + * Dependencies between packages based on symbols used in the code - [_example_](docs/test_cases/t30002.md) * Interactive links to online code to packages * **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) To see what `clang-uml` can do so far, checkout the diagrams generated for unit test cases [here](./docs/test_cases.md) and examples in