From 8c8bd4464a261aff324bf83730039613314dce34 Mon Sep 17 00:00:00 2001 From: Bartek Kryza Date: Mon, 27 Mar 2023 22:52:31 +0200 Subject: [PATCH] Updated docs --- README.md | 4 +++- docs/diagram_filters.md | 21 +++++++++++++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f2130f5..e6751d1b 100644 --- a/README.md +++ b/README.md @@ -171,11 +171,13 @@ using BVector2 = BVector; using AIntString = AString; using ACharString = AString; -using AWCharString = AString; + using AStringString = AString; using BStringString = AStringString; class R { + using AWCharString = AString; + PairPairBA bapair; APtr abool; diff --git a/docs/diagram_filters.md b/docs/diagram_filters.md index 548f4e71..8af8d4f3 100644 --- a/docs/diagram_filters.md +++ b/docs/diagram_filters.md @@ -4,6 +4,7 @@ * [`namespaces`](#namespaces) * [`elements`](#elements) +* [`paths`](#paths) * [`context`](#context) * [`relationships`](#relationships) * [`subclasses`](#subclasses) @@ -52,6 +53,26 @@ from an included namespace: - ns1::ns2::MyClass ``` +## `paths` + +This filter allows to include or exclude from the diagram elements declared +in specific files. + +```yaml +diagrams: + t00061_class: + type: class + relative_to: ../../tests/t00061 + glob: [t00061.cc] + include: + paths: [include/t00061_a.h] + using_namespace: + - clanguml::t00061 +``` + +Currently, this filter does not allow any globbing or wildcards, however +paths to directories can be specified. + ## `context` This filter allows to limit the diagram elements only to classes which are in direct relationship (of any kind) with