Updated test cases documentation
This commit is contained in:
Bartek Kryza
@@ -116,3 +116,442 @@ private:
|
||||
```
|
||||
## Generated UML diagrams
|
||||
|
||||
## Generated JSON models
|
||||
```json
|
||||
{
|
||||
"diagram_type": "class",
|
||||
"elements": [
|
||||
{
|
||||
"bases": [],
|
||||
"comment": {
|
||||
"brief": [
|
||||
" This is class A\n"
|
||||
],
|
||||
"formatted": "\\brief This is class A",
|
||||
"paragraph": [
|
||||
" \n"
|
||||
],
|
||||
"raw": "/// \\brief This is class A",
|
||||
"text": "\n \n"
|
||||
},
|
||||
"display_name": "clanguml::t00002::A",
|
||||
"id": "987634239855407298",
|
||||
"is_abstract": true,
|
||||
"is_nested": false,
|
||||
"is_struct": false,
|
||||
"is_template": false,
|
||||
"is_union": false,
|
||||
"members": [],
|
||||
"methods": [
|
||||
{
|
||||
"access": "public",
|
||||
"comment": {
|
||||
"formatted": "Abstract foo_a",
|
||||
"paragraph": [
|
||||
" Abstract foo_a\n"
|
||||
],
|
||||
"raw": "/// Abstract foo_a",
|
||||
"text": "\n Abstract foo_a\n"
|
||||
},
|
||||
"is_const": false,
|
||||
"is_defaulted": false,
|
||||
"is_implicit": false,
|
||||
"is_pure_virtual": true,
|
||||
"is_static": false,
|
||||
"is_virtual": true,
|
||||
"name": "foo_a",
|
||||
"parameters": [],
|
||||
"type": "void"
|
||||
},
|
||||
{
|
||||
"access": "public",
|
||||
"comment": {
|
||||
"formatted": "Abstract foo_c",
|
||||
"paragraph": [
|
||||
" Abstract foo_c\n"
|
||||
],
|
||||
"raw": "/// Abstract foo_c",
|
||||
"text": "\n Abstract foo_c\n"
|
||||
},
|
||||
"is_const": false,
|
||||
"is_defaulted": false,
|
||||
"is_implicit": false,
|
||||
"is_pure_virtual": true,
|
||||
"is_static": false,
|
||||
"is_virtual": true,
|
||||
"name": "foo_c",
|
||||
"parameters": [],
|
||||
"type": "void"
|
||||
}
|
||||
],
|
||||
"name": "A",
|
||||
"namespace": "clanguml::t00002",
|
||||
"source_location": {
|
||||
"file": "../../tests/t00002/t00002.cc",
|
||||
"line": 7
|
||||
},
|
||||
"template_parameters": [],
|
||||
"type": "class"
|
||||
},
|
||||
{
|
||||
"bases": [
|
||||
{
|
||||
"access": "public",
|
||||
"id": "987634239855407298",
|
||||
"is_virtual": false,
|
||||
"name": "clanguml::t00002::A"
|
||||
}
|
||||
],
|
||||
"comment": {
|
||||
"brief": [
|
||||
" This is class B\n"
|
||||
],
|
||||
"formatted": "\\brief This is class B",
|
||||
"paragraph": [
|
||||
" \n"
|
||||
],
|
||||
"raw": "/// \\brief This is class B",
|
||||
"text": "\n \n"
|
||||
},
|
||||
"display_name": "clanguml::t00002::B",
|
||||
"id": "594234458687375950",
|
||||
"is_abstract": false,
|
||||
"is_nested": false,
|
||||
"is_struct": false,
|
||||
"is_template": false,
|
||||
"is_union": false,
|
||||
"members": [],
|
||||
"methods": [
|
||||
{
|
||||
"access": "public",
|
||||
"is_const": false,
|
||||
"is_defaulted": false,
|
||||
"is_implicit": false,
|
||||
"is_pure_virtual": false,
|
||||
"is_static": false,
|
||||
"is_virtual": true,
|
||||
"name": "foo_a",
|
||||
"parameters": [],
|
||||
"type": "void"
|
||||
}
|
||||
],
|
||||
"name": "B",
|
||||
"namespace": "clanguml::t00002",
|
||||
"source_location": {
|
||||
"file": "../../tests/t00002/t00002.cc",
|
||||
"line": 16
|
||||
},
|
||||
"template_parameters": [],
|
||||
"type": "class"
|
||||
},
|
||||
{
|
||||
"bases": [
|
||||
{
|
||||
"access": "public",
|
||||
"id": "987634239855407298",
|
||||
"is_virtual": false,
|
||||
"name": "clanguml::t00002::A"
|
||||
}
|
||||
],
|
||||
"comment": {
|
||||
"brief": [
|
||||
" This is class C - class C has a long comment\n"
|
||||
],
|
||||
"formatted": "@brief This is class C - class C has a long comment\n\nVivamus integer non suscipit taciti mus etiam at primis tempor sagittis sit,\neuismod libero facilisi aptent elementum felis blandit cursus gravida sociis\nerat ante, eleifend lectus nullam dapibus netus feugiat curae curabitur est\nad.",
|
||||
"paragraph": [
|
||||
" \n",
|
||||
" Vivamus integer non suscipit taciti mus etiam at primis tempor sagittis sit,\n euismod libero facilisi aptent elementum felis blandit cursus gravida sociis\n erat ante, eleifend lectus nullam dapibus netus feugiat curae curabitur est\n ad.\n"
|
||||
],
|
||||
"raw": "/// @brief This is class C - class C has a long comment\n///\n/// Vivamus integer non suscipit taciti mus etiam at primis tempor sagittis sit,\n/// euismod libero facilisi aptent elementum felis blandit cursus gravida sociis\n/// erat ante, eleifend lectus nullam dapibus netus feugiat curae curabitur est\n/// ad.",
|
||||
"text": "\n \n\n Vivamus integer non suscipit taciti mus etiam at primis tempor sagittis sit,\n euismod libero facilisi aptent elementum felis blandit cursus gravida sociis\n erat ante, eleifend lectus nullam dapibus netus feugiat curae curabitur est\n ad.\n"
|
||||
},
|
||||
"display_name": "clanguml::t00002::C",
|
||||
"id": "1142499429598587507",
|
||||
"is_abstract": false,
|
||||
"is_nested": false,
|
||||
"is_struct": false,
|
||||
"is_template": false,
|
||||
"is_union": false,
|
||||
"members": [],
|
||||
"methods": [
|
||||
{
|
||||
"access": "public",
|
||||
"comment": {
|
||||
"formatted": "Do nothing unless override is provided",
|
||||
"paragraph": [
|
||||
" Do nothing unless override is provided\n"
|
||||
],
|
||||
"raw": "/// Do nothing unless override is provided",
|
||||
"text": "\n Do nothing unless override is provided\n"
|
||||
},
|
||||
"is_const": false,
|
||||
"is_defaulted": false,
|
||||
"is_implicit": false,
|
||||
"is_pure_virtual": false,
|
||||
"is_static": false,
|
||||
"is_virtual": true,
|
||||
"name": "foo_c",
|
||||
"parameters": [],
|
||||
"type": "void"
|
||||
}
|
||||
],
|
||||
"name": "C",
|
||||
"namespace": "clanguml::t00002",
|
||||
"source_location": {
|
||||
"file": "../../tests/t00002/t00002.cc",
|
||||
"line": 27
|
||||
},
|
||||
"template_parameters": [],
|
||||
"type": "class"
|
||||
},
|
||||
{
|
||||
"bases": [
|
||||
{
|
||||
"access": "public",
|
||||
"id": "594234458687375950",
|
||||
"is_virtual": false,
|
||||
"name": "clanguml::t00002::B"
|
||||
},
|
||||
{
|
||||
"access": "public",
|
||||
"id": "1142499429598587507",
|
||||
"is_virtual": false,
|
||||
"name": "clanguml::t00002::C"
|
||||
}
|
||||
],
|
||||
"comment": {
|
||||
"formatted": "This is class D\nwhich is a little like B\nand a little like C",
|
||||
"paragraph": [
|
||||
" This is class D\n which is a little like B\n and a little like C\n"
|
||||
],
|
||||
"raw": "/// This is class D\n/// which is a little like B\n/// and a little like C",
|
||||
"text": "\n This is class D\n which is a little like B\n and a little like C\n"
|
||||
},
|
||||
"display_name": "clanguml::t00002::D",
|
||||
"id": "60950494980414724",
|
||||
"is_abstract": false,
|
||||
"is_nested": false,
|
||||
"is_struct": false,
|
||||
"is_template": false,
|
||||
"is_union": false,
|
||||
"members": [
|
||||
{
|
||||
"access": "private",
|
||||
"comment": {
|
||||
"formatted": "All the A pointers",
|
||||
"paragraph": [
|
||||
" All the A pointers\n"
|
||||
],
|
||||
"raw": "/// All the A pointers",
|
||||
"text": "\n All the A pointers\n"
|
||||
},
|
||||
"is_static": false,
|
||||
"name": "as",
|
||||
"source_location": {
|
||||
"file": "../../tests/t00002/t00002.cc",
|
||||
"line": 58
|
||||
},
|
||||
"type": "std::vector<A *>"
|
||||
}
|
||||
],
|
||||
"methods": [
|
||||
{
|
||||
"access": "public",
|
||||
"comment": {
|
||||
"formatted": "\n Forward foo_a\n ",
|
||||
"paragraph": [
|
||||
" Forward foo_a\n"
|
||||
],
|
||||
"raw": "/**\n * Forward foo_a\n */",
|
||||
"text": "\n Forward foo_a\n"
|
||||
},
|
||||
"is_const": false,
|
||||
"is_defaulted": false,
|
||||
"is_implicit": false,
|
||||
"is_pure_virtual": false,
|
||||
"is_static": false,
|
||||
"is_virtual": true,
|
||||
"name": "foo_a",
|
||||
"parameters": [],
|
||||
"type": "void"
|
||||
},
|
||||
{
|
||||
"access": "public",
|
||||
"comment": {
|
||||
"formatted": "\n Forward foo_c\n ",
|
||||
"paragraph": [
|
||||
" Forward foo_c\n"
|
||||
],
|
||||
"raw": "/**\n * Forward foo_c\n */",
|
||||
"text": "\n Forward foo_c\n"
|
||||
},
|
||||
"is_const": false,
|
||||
"is_defaulted": false,
|
||||
"is_implicit": false,
|
||||
"is_pure_virtual": false,
|
||||
"is_static": false,
|
||||
"is_virtual": true,
|
||||
"name": "foo_c",
|
||||
"parameters": [],
|
||||
"type": "void"
|
||||
}
|
||||
],
|
||||
"name": "D",
|
||||
"namespace": "clanguml::t00002",
|
||||
"source_location": {
|
||||
"file": "../../tests/t00002/t00002.cc",
|
||||
"line": 36
|
||||
},
|
||||
"template_parameters": [],
|
||||
"type": "class"
|
||||
},
|
||||
{
|
||||
"bases": [
|
||||
{
|
||||
"access": "public",
|
||||
"id": "594234458687375950",
|
||||
"is_virtual": true,
|
||||
"name": "clanguml::t00002::B"
|
||||
},
|
||||
{
|
||||
"access": "public",
|
||||
"id": "1142499429598587507",
|
||||
"is_virtual": true,
|
||||
"name": "clanguml::t00002::C"
|
||||
}
|
||||
],
|
||||
"display_name": "clanguml::t00002::E",
|
||||
"id": "2237886670308966220",
|
||||
"is_abstract": false,
|
||||
"is_nested": false,
|
||||
"is_struct": false,
|
||||
"is_template": false,
|
||||
"is_union": false,
|
||||
"members": [
|
||||
{
|
||||
"access": "private",
|
||||
"comment": {
|
||||
"formatted": "All the A pointers",
|
||||
"paragraph": [
|
||||
" All the A pointers\n"
|
||||
],
|
||||
"raw": "/// All the A pointers",
|
||||
"text": "\n All the A pointers\n"
|
||||
},
|
||||
"is_static": false,
|
||||
"name": "as",
|
||||
"source_location": {
|
||||
"file": "../../tests/t00002/t00002.cc",
|
||||
"line": 83
|
||||
},
|
||||
"type": "std::vector<A *>"
|
||||
}
|
||||
],
|
||||
"methods": [
|
||||
{
|
||||
"access": "public",
|
||||
"comment": {
|
||||
"formatted": "\n Forward foo_a",
|
||||
"paragraph": [
|
||||
" Forward foo_a\n"
|
||||
],
|
||||
"raw": "///\n /// Forward foo_a\n ///",
|
||||
"text": "\n Forward foo_a\n"
|
||||
},
|
||||
"is_const": false,
|
||||
"is_defaulted": false,
|
||||
"is_implicit": false,
|
||||
"is_pure_virtual": false,
|
||||
"is_static": false,
|
||||
"is_virtual": true,
|
||||
"name": "foo_a",
|
||||
"parameters": [],
|
||||
"type": "void"
|
||||
},
|
||||
{
|
||||
"access": "public",
|
||||
"comment": {
|
||||
"formatted": "\n Forward foo_c",
|
||||
"paragraph": [
|
||||
" Forward foo_c\n"
|
||||
],
|
||||
"raw": "///\n /// Forward foo_c\n ///",
|
||||
"text": "\n Forward foo_c\n"
|
||||
},
|
||||
"is_const": false,
|
||||
"is_defaulted": false,
|
||||
"is_implicit": false,
|
||||
"is_pure_virtual": false,
|
||||
"is_static": false,
|
||||
"is_virtual": true,
|
||||
"name": "foo_c",
|
||||
"parameters": [],
|
||||
"type": "void"
|
||||
}
|
||||
],
|
||||
"name": "E",
|
||||
"namespace": "clanguml::t00002",
|
||||
"source_location": {
|
||||
"file": "../../tests/t00002/t00002.cc",
|
||||
"line": 61
|
||||
},
|
||||
"template_parameters": [],
|
||||
"type": "class"
|
||||
}
|
||||
],
|
||||
"name": "t00002_class",
|
||||
"relationships": [
|
||||
{
|
||||
"access": "public",
|
||||
"destination": "987634239855407298",
|
||||
"source": "594234458687375950",
|
||||
"type": "extension"
|
||||
},
|
||||
{
|
||||
"access": "public",
|
||||
"destination": "987634239855407298",
|
||||
"source": "1142499429598587507",
|
||||
"type": "extension"
|
||||
},
|
||||
{
|
||||
"access": "private",
|
||||
"destination": "987634239855407298",
|
||||
"label": "as",
|
||||
"source": "60950494980414724",
|
||||
"type": "association"
|
||||
},
|
||||
{
|
||||
"access": "public",
|
||||
"destination": "594234458687375950",
|
||||
"source": "60950494980414724",
|
||||
"type": "extension"
|
||||
},
|
||||
{
|
||||
"access": "public",
|
||||
"destination": "1142499429598587507",
|
||||
"source": "60950494980414724",
|
||||
"type": "extension"
|
||||
},
|
||||
{
|
||||
"access": "private",
|
||||
"destination": "987634239855407298",
|
||||
"label": "as",
|
||||
"source": "2237886670308966220",
|
||||
"type": "association"
|
||||
},
|
||||
{
|
||||
"access": "public",
|
||||
"destination": "594234458687375950",
|
||||
"source": "2237886670308966220",
|
||||
"type": "extension"
|
||||
},
|
||||
{
|
||||
"access": "public",
|
||||
"destination": "1142499429598587507",
|
||||
"source": "2237886670308966220",
|
||||
"type": "extension"
|
||||
}
|
||||
],
|
||||
"using_namespace": "clanguml::t00002"
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user