diff --git a/docs/diagram_filters.md b/docs/diagram_filters.md index 8b1e7eb5..9b1620fc 100644 --- a/docs/diagram_filters.md +++ b/docs/diagram_filters.md @@ -57,19 +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`, `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`, `r: 'ns1::ns2::ClassA.+'` | -| `relationships` | Type of relationship | `inheritance`, `composition`, `aggregation`, `ownership`, `association`, `instantiation`, `friendship`, `dependency` | -| `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`, `r: 'ns1::ns2::ClassA.+'` | -| `dependencies` | Qualified name or regex | `ns1::ns2::ClassA`, `r: 'ns1::ns2::ClassA.+'` | +| `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```, ```r: 'ns1::ns2::ClassA.+'``` | +| `relationships` | Type of relationship | ```inheritance```, ```composition```, ```aggregation```, ```ownership```, ```association```, ```instantiation```, ```friendship```, ```dependency``` | +| `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```, ```r: 'ns1::ns2::ClassA.+'``` | +| `dependencies` | Qualified name or regex | ```ns1::ns2::ClassA```, ```r: 'ns1::ns2::ClassA.+'``` | The following filters are available. diff --git a/docs/generator_types.md b/docs/generator_types.md index c434fb03..de2961c8 100644 --- a/docs/generator_types.md +++ b/docs/generator_types.md @@ -16,7 +16,7 @@ For instance to generate both types of diagrams run `clang-uml` as follows: clang-uml -g plantuml -g json ``` -By default, only `plantuml` diagram are generated. +By default, only `plantuml` diagrams are generated. ## PlantUML