Updated test cases documentation

This commit is contained in:
Bartek Kryza
2021-10-16 16:01:28 +02:00
parent 388c52cd7a
commit 3b0a454e4e
5 changed files with 46 additions and 3 deletions

View File

@@ -34,6 +34,7 @@
* [t00033](./test_cases/t00033.md) - Nested template instantiation dependency test case * [t00033](./test_cases/t00033.md) - Nested template instantiation dependency test case
* [t00034](./test_cases/t00034.md) - Template metaprogramming type function test case * [t00034](./test_cases/t00034.md) - Template metaprogramming type function test case
## Sequence diagrams ## Sequence diagrams
* [t20001](./test_cases/t20001.md) - Basic sequence diagram * [t20001](./test_cases/t20001.md) - Basic sequence diagram test case
* [t20002](./test_cases/t20002.md) - Free function sequence diagram test case
## Configuration diagrams ## Configuration diagrams
* [t90000](./test_cases/t90000.md) - Basic config test * [t90000](./test_cases/t90000.md) - Basic config test

View File

@@ -1,4 +1,4 @@
# t20001 - Basic sequence diagram # t20001 - Basic sequence diagram test case
## Config ## Config
```yaml ```yaml
compilation_database_dir: .. compilation_database_dir: ..
@@ -101,4 +101,4 @@ int tmain()
``` ```
## Generated UML diagrams ## Generated UML diagrams
![t20001_sequence](./t20001_sequence.png "Basic sequence diagram") ![t20001_sequence](./t20001_sequence.png "Basic sequence diagram test case")

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

42
docs/test_cases/t20002.md Normal file
View File

@@ -0,0 +1,42 @@
# t20002 - Free function sequence diagram test case
## Config
```yaml
compilation_database_dir: ..
output_directory: puml
diagrams:
t20002_sequence:
type: sequence
glob:
- ../../tests/t20002/t20002.cc
include:
namespaces:
- clanguml::t20002
using_namespace:
- clanguml::t20002
start_from:
- function: "clanguml::t20002::m1()"
```
## Source code
File t20002.cc
```cpp
#include <algorithm>
#include <numeric>
#include <vector>
namespace clanguml {
namespace t20002 {
void m4() { }
void m3() { m4(); }
void m2() { m3(); }
void m1() { m2(); }
}
}
```
## Generated UML diagrams
![t20002_sequence](./t20002_sequence.png "Free function sequence diagram test case")

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.7 KiB