Updated docs

2023-05-28 19:08:10 +02:00
parent 81c7ce71df
commit 3e97a37c5f
220 changed files with 5466 additions and 3800 deletions
--- a/docs/test_cases/t30010.md
+++ b/docs/test_cases/t30010.md
@@ -0,0 +1,118 @@
+# t30010 - Package diagram with packages from directory structure
+## Config
+```yaml
+compilation_database_dir: ..
+output_directory: puml
+diagrams:
+  t30010_package:
+    type: package
+    generate_packages: true
+    package_type: directory
+    glob:
+      - t30010.cc
+    relative_to: ../../../tests/t30010
+    include:
+      namespaces:
+        - clanguml::t30010
+#      paths:
+#        - .
+    using_namespace:
+      - clanguml::t30010
+```
+## Source code
+File t30010.cc
+```cpp
+#include "app/app.h"
+
+namespace clanguml {
+namespace t30010 {
+
+App app;
+
+} // namespace t30002
+} // namespace clanguml
+
+```
+## Generated UML diagrams
+![t30010_package](./t30010_package.svg "Package diagram with packages from directory structure")
+## Generated JSON models
+```json
+{
+  "diagram_type": "package",
+  "elements": [
+    {
+      "display_name": "libraries",
+      "elements": [
+        {
+          "display_name": "lib1",
+          "id": "879212264535378961",
+          "is_deprecated": false,
+          "name": "lib1",
+          "type": "namespace"
+        },
+        {
+          "display_name": "lib2",
+          "id": "1522606219626203424",
+          "is_deprecated": false,
+          "name": "lib2",
+          "type": "namespace"
+        },
+        {
+          "display_name": "lib3",
+          "id": "2263709579652581325",
+          "is_deprecated": false,
+          "name": "lib3",
+          "type": "namespace"
+        },
+        {
+          "display_name": "lib4",
+          "id": "1103453030023410219",
+          "is_deprecated": false,
+          "name": "lib4",
+          "type": "namespace"
+        }
+      ],
+      "id": "879401191375500756",
+      "is_deprecated": false,
+      "name": "libraries",
+      "type": "namespace"
+    },
+    {
+      "display_name": "app",
+      "id": "2001320261642080149",
+      "is_deprecated": false,
+      "name": "app",
+      "type": "namespace"
+    }
+  ],
+  "metadata": {
+    "clang_uml_version": "0.3.5-27-g81c7ce7",
+    "llvm_version": "Ubuntu clang version 15.0.6",
+    "schema_version": 1
+  },
+  "name": "t30010_package",
+  "relationships": [
+    {
+      "destination": "879212264535378961",
+      "source": "2001320261642080149",
+      "type": "dependency"
+    },
+    {
+      "destination": "1522606219626203424",
+      "source": "2001320261642080149",
+      "type": "dependency"
+    },
+    {
+      "destination": "2263709579652581325",
+      "source": "2001320261642080149",
+      "type": "dependency"
+    },
+    {
+      "destination": "1103453030023410219",
+      "source": "2001320261642080149",
+      "type": "dependency"
+    }
+  ],
+  "using_namespace": "clanguml::t30010"
+}
+```