Skip to content

Commit

Permalink
Updated test cases docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bkryza committed Sep 30, 2024
1 parent b7c3e1f commit f608463
Show file tree
Hide file tree
Showing 266 changed files with 5,671 additions and 3,590 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOG

* Added support for Objective C (#296)
* Added option to fold repeated activities in sequence diagrams (#317)
* Fixed default arguments braces in mermaid diagrams (#312)

### 0.5.4
* Updated thirdparty dependencies (#306)
* Added regular expression support to remove_compile_flags (#303)
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ types and contents of each generated diagram.
The diagrams can be generated in [PlantUML](https://plantuml.com),
[MermaidJS](https://mermaid.js.org/) and JSON formats.

`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,
as well as C and Objective-C.

Full documentation can be found at [clang-uml.github.io](https://clang-uml.github.io).

Expand Down Expand Up @@ -45,6 +46,7 @@ Main features supported so far include:
* C++20 concept constraints - [_example_](docs/test_cases/t00059.md)
* C++20 coroutines - [_example_](docs/test_cases/t00069.md)
* Diagram content filtering based on C++20 modules - [_example_](docs/test_cases/t00070.md)
* Objective-C class diagrams - [_example_](docs/test_cases/t00084.md)
* **Sequence diagram generation**
* Generation of sequence diagram from specific method or function - [_example_](docs/test_cases/t20001.md)
* Generation of loop and conditional statements - [_example_](docs/test_cases/t20021.md)
Expand All @@ -54,12 +56,14 @@ Main features supported so far include:
* Handling of lambda expressions - [_example_](docs/test_cases/t20012.md)
* Interactive links to online code to classes and call expressions - [_example_](https://raw.githubusercontent.com/bkryza/clang-uml/master/docs/test_cases/t20021_sequence.svg)
* Support for CUDA Kernel and CUDA Device function calls - [_example_](docs/test_cases/t20050.md)
* Objective-C sequence diagrams - [_example_](docs/test_cases/t20058.md)
* **Package diagram generation**
* Generation of package diagram based on C++ namespaces - [_example_](docs/test_cases/t30001.md)
* Generation of package diagram based on subdirectories - [_example_](docs/test_cases/t30010.md)
* Generation of package diagram based on C++20 modules - [_example_](docs/test_cases/t30014.md)
* Dependencies between packages based on symbols used in the code - [_example_](docs/test_cases/t30002.md)
* Interactive links to online code to packages - [_example_](https://raw.githubusercontent.com/bkryza/clang-uml/master/docs/test_cases/t30002_package.svg)
* Objective-C package diagrams based on subdirectories - [_example_](docs/test_cases/t30016.md)
* **Include graph diagram generation**
* Show include graph for selected files - [_example_](docs/test_cases/t40001.md)

Expand Down Expand Up @@ -88,6 +92,7 @@ Nowadays, this file can be generated rather easily using multiple methods:
* For SCons, invoke `compilation_db` tool (requires SCons > 4.0.0)
* For Bazel, try [bazel-compile-commands-extractor](https://github.com/hedronvision/bazel-compile-commands-extractor)
* For Microsoft Visual Studio projects try [Clang Power Tools](https://www.clangpowertools.com)
* For Objective-C based XCode projects see [xcpretty](https://github.com/xcpretty/xcpretty)

### Invocation

Expand Down
3 changes: 3 additions & 0 deletions docs/test_cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
* [t00083](./test_cases/t00083.md) - Test case for advanced diagram filter exclusion test with subclasses and namespaces
* [t00084](./test_cases/t00084.md) - Objective-C overall use case
* [t00085](./test_cases/t00085.md) - Objective-C test case for various class members and methods
* [t00086](./test_cases/t00086.md) - Objective-C nested structs and enums test case
## Sequence diagrams
* [t20001](./test_cases/t20001.md) - Basic sequence diagram test case
* [t20002](./test_cases/t20002.md) - Free function sequence diagram test case
Expand Down Expand Up @@ -148,6 +149,8 @@
* [t20055](./test_cases/t20055.md) - Test case for advanced filter in sequence diagram
* [t20056](./test_cases/t20056.md) - Test case for option to fold repeated activities in sequence diagram
* [t20057](./test_cases/t20057.md) - Basic Objective-C sequence diagram test case
* [t20058](./test_cases/t20058.md) - Objective-C sequence diagram with method params test case
* [t20059](./test_cases/t20059.md) - Objective-C sequence diagram with polymorphism test case
## Package diagrams
* [t30001](./test_cases/t30001.md) - Basic package diagram test case
* [t30002](./test_cases/t30002.md) - Package dependency test case
Expand Down
50 changes: 25 additions & 25 deletions docs/test_cases/t00002_class.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions docs/test_cases/t00002_class_mermaid.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit f608463

Please sign in to comment.