From 6d329dfdf6fcec4507723f9119085ff47b64fc24 Mon Sep 17 00:00:00 2001 From: Bartek Kryza Date: Sat, 10 Jun 2023 19:36:07 +0200 Subject: [PATCH] Fixed diagram filters docs --- docs/diagram_filters.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/diagram_filters.md b/docs/diagram_filters.md index b42bb74c..0fb896b7 100644 --- a/docs/diagram_filters.md +++ b/docs/diagram_filters.md @@ -40,7 +40,7 @@ Some filters accept either specified exact values, some support regular expressions while some except glob patterns. For filters which accept regular expressions, the regular expression has to -be provided as a map `re: 'pattern'` due to the fact the pointer (`*`) otherwise +be provided as a map `r: 'pattern'` due to the fact the pointer (`*`) otherwise would have to be escaped in situations such as `mycontainer`, so for instance to specify that the diagram should exclude all classes containing the word `test` simply add the following filter: @@ -48,7 +48,7 @@ word `test` simply add the following filter: ```yaml exclude: elements: - - re: '.*test.*' + - r: '.*test.*' ``` `paths` filter is currently the only filter which accepts `glob` like patterns. @@ -57,18 +57,19 @@ The following table specifies the values allowed in each filter: | Filter name | Possible values | Example values | |-------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `namespaces` | Qualified name or regex | - `ns1::ns2::ClassA`
- `re: '.\*detail.\*'` | -| `elements` | Qualified name or regex | - `ns1::ns2::ClassA`
- `re: '.\*detail.\*'` | +| `namespaces` | Qualified name or regex | - `ns1::ns2::ClassA`
- `r: '.*detail.*'` | +| `elements` | Qualified name or regex | - `ns1::ns2::ClassA`
- `r: '.*detail.*'` | +| `element_types` | Types of diagram elements | - `class`
- `enum`
- `concept` | | `paths` | File or dir path or glob pattern | - `src/dir1`
- `src/dir2/a.cpp`
- `src/dir3/*.cpp` | -| `context` | Qualified name or regex | - `ns1::ns2::ClassA`
- `re: 'ns1::ns2::ClassA.+'` | +| `context` | Qualified name or regex | - `ns1::ns2::ClassA`
- `r: 'ns1::ns2::ClassA.+'` | | `relationships` | Type of relationship | - `inheritance`
- `composition`
- `aggregation`
- `ownership`
- `association`
- `instantiation`
- `friendship`
- `dependency` | -| `subclasses` | Qualified name or regex | - `ns1::ns2::ClassA`
- `re: 'ns1::ns2::ClassA.+'` | -| `parents` | Qualified name or regex | - `ns1::ns2::ClassA`
- `re: 'ns1::ns2::ClassA.+'` | -| `specializations` | Qualified name or regex | - `ns1::ns2::ClassA`
- `re: 'ns1::ns2::ClassA.+'` | +| `subclasses` | Qualified name or regex | - `ns1::ns2::ClassA`
- `r: 'ns1::ns2::ClassA.+'` | +| `parents` | Qualified name or regex | - `ns1::ns2::ClassA`
- `r: 'ns1::ns2::ClassA.+'` | +| `specializations` | Qualified name or regex | - `ns1::ns2::ClassA`
- `r: 'ns1::ns2::ClassA.+'` | | `access` | Method or member access scope | - `public`
- `protected`
- `private` | | `method_types` | Type of class method | - `constructor`
- `destructor`
- `assignment`
- `operator`
- `defaulted`
- `deleted`
- `static` | -| `dependants` | Qualified name or regex | - `ns1::ns2::ClassA`
- `re: 'ns1::ns2::ClassA.+'` | -| `dependencies` | Qualified name or regex | - `ns1::ns2::ClassA`
- `re: 'ns1::ns2::ClassA.+'` | +| `dependants` | Qualified name or regex | - `ns1::ns2::ClassA`
- `r: 'ns1::ns2::ClassA.+'` | +| `dependencies` | Qualified name or regex | - `ns1::ns2::ClassA`
- `r: 'ns1::ns2::ClassA.+'` | The following filters are available. @@ -169,7 +170,7 @@ This filter allows to include or exclude specializations and instantiations of a ## `access` -This filter allows to include or exclude class methods and members based on their access scope, allowed values are: +This filter allows to include or exclude class methods and members based on their access scope, allowed values ar: * `public` * `protected` @@ -177,7 +178,7 @@ This filter allows to include or exclude class methods and members based on thei ## `method_types` -This filter allows to include or exclude various method types from the class diagram, allowed values are: +This filter allows to include or exclude various method types from the class diagram, allowed values ar: * constructor * destructor * assignment