-
Notifications
You must be signed in to change notification settings - Fork 34
/
USAGE.txt
45 lines (41 loc) · 2.39 KB
/
USAGE.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Usage: dcdg [options]
-b, --builder=<NAME> Builder to use to construct a class diagram
(defaults to "plantuml")
-e, --exclude=<TYPE> Class / type names to exclude, can be a regular
expression
--exclude-private=<KIND> Exclude private entities (field, method, class,
or all)
--exclude-has-a Exclude has-a / aggregation relationships from
the diagram output
--exclude-is-a Exclude is-a / extension relationships from the
diagram output
--exported-only Include only classes exported from the Dart
package
--has-a=<CLASS> Include only classes with a has-a relationship
to any of the named classes
--is-a=<CLASS> Include only classes with an is-a relationship
to any of the named classes
-h, --help Show usage information
-V, --verbose Show verbose output
-i, --include=<TYPE> Class / type names to include, can be a regular
expression
-o, --output=<FILE> File to which output should be written (stdout
if omitted)
(defaults to "")
-p, --package=<DIR> Path to the root of the Dart package to scan
(defaults to ".")
-s, --search-path=<DIR> Directory relative to the package root to search
for classes
(defaults to "lib")
-v, --version Show the version number and exit
Available builders:
* plantuml - PlantUML builder that attempts to be feature-complete
* dot - Graphviz builder that only handles inheritance
* nomnoml - Nomnoml builder for embedding diagrams in web pages
* mermaid - Mermaid builder that attempts to be feature-complete
The --include, --exclude, --has-a, and --is-a
options accept regular expressions. These options accept multiple values,
separated by commas, or they can be passed multiple times.
Note: If both exclude and include are supplied, types that
are in both lists will be removed from the includes list and then the
includes list will be applied as usual.