Updated test cases documentation

This commit is contained in:
Bartek Kryza
2022-01-23 22:22:50 +01:00
parent 98f103ec72
commit 7defaee37f
5 changed files with 48 additions and 0 deletions

View File

@@ -38,5 +38,6 @@
* [t20002](./test_cases/t20002.md) - Free function sequence diagram test case
## Package diagrams
* [t30001](./test_cases/t30001.md) - Basic package diagram test case
* [t30002](./test_cases/t30002.md) - Package dependency test case
## Configuration diagrams
* [t90000](./test_cases/t90000.md) - Basic config test

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.8 KiB

After

Width:  |  Height:  |  Size: 8.8 KiB

44
docs/test_cases/t30002.md Normal file
View File

@@ -0,0 +1,44 @@
# t30002 - Package dependency test case
## Config
```yaml
compilation_database_dir: ..
output_directory: puml
diagrams:
t30002_package:
type: package
glob:
- ../../tests/t30002/t30002.cc
include:
namespaces:
- clanguml::t30002
exclude:
namespaces:
- clanguml::t30002::detail
using_namespace:
- clanguml::t30002
plantuml:
before:
- "' t30002 test package diagram"
```
## Source code
File t30002.cc
```cpp
#include <memory>
namespace clanguml {
namespace t30002 {
namespace A::AA::AAA {
struct CA {
};
}
namespace B::BB::BBB {
struct CBA {
A::AA::AAA::CA *ca_;
};
}
} // namespace t30002
} // namespace clanguml
```
## Generated UML diagrams
![t30002_package](./t30002_package.png "Package dependency test case")

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.3 KiB

View File

@@ -110,6 +110,9 @@ test_cases:
- name: t30001
title: Basic package diagram test case
description:
- name: t30002
title: Package dependency test case
description:
Configuration diagrams:
- name: t90000
title: Basic config test