| Property | Optional? | Description |
|---|---|---|
| maven.dotuml.public | Yes |
Javadoc option -public. Specifies whether or
not only public classes and members shold be
shown in the generated diagram. The default value is
false. Conflict resolution is governed by the
ant task.
|
| maven.dotuml.protected | Yes |
Javadoc option -protected. Specifies whether
or not only protected and public
classes and members shold be shown in the generated diagram.
The default value is false. Conflict resolution
is governed by the ant task.
|
| maven.dotuml.package | Yes |
Javadoc option -package. Specifies whether or
not only package, protected and
public classes and members shold be shown in
the generated diagram. The default value is false.
Conflict resolution is governed by the ant task.
|
| maven.dotuml.private | Yes |
Javadoc option -private. Specifies whether or
not even private classes and members (as well as
package, protected and
public classes and members) shold be shown in
the generated diagram. The default value is true.
Conflict resolution is governed by the ant task.
|
| maven.dotuml.doclet | Yes |
Javadoc option -doclet. Specifies the class name of a
custom doclet. The default and supposedly fixed value
is UmlGraph, but this may be overridden
in the context of goal invocation.
|
| Property | Optional? | Description |
|---|---|---|
| maven.dotuml.pic2plot.src.dir | Yes | Sets the source directory for the .pic files. Default to ${maven.src.dir}/pic. |
| maven.dotuml.pic2plot.dest.dir | Yes | Sets the destination directory for the generated images. Default to ${maven.docs.dest}/sequence |
| maven.dotuml.pic2plot.fontsize | Yes | Sets the font size of the generated images. Default to 12pt. |
| Note: the sequence.pic file from the UmlGraph distribution has to be somewhere in your project path. The header of the .pic files require a relative/absolute path to the sequence.pic file. | ||
| Property | Optional? | Description |
|---|---|---|
| maven.dotuml.qualify | Yes |
UmlGraph option -qualify. Specifies whether or not to
produce fully qualified class names. The default value
is false.
|
| maven.dotuml.horizontal | Yes |
UmlGraph option -qualify. Specifies whether or not to
layout the graph in the horizontal direction. The
default value is false.
|
| maven.dotuml.attributes | Yes |
UmlGraph option -attributes. Specifies whether or not to
show class attributes, i.e. Java fields. The
default value is true.
|
| maven.dotuml.operations | Yes |
UmlGraph option -operations. Specifies whether or not to
show class operations, i.e. Java methods. The
default value is true.
|
| maven.dotuml.visibility | Yes |
UmlGraph option -visibility. Specifies whether or not to
adorn class elements according to their visibility
(private, public, protected). The
default value is true.
|
| maven.dotuml.types | Yes |
UmlGraph option -types. Specifies whether or not to
add type information to attributes and operations. The
default value is true.
|
| maven.dotuml.all | Yes |
UmlGraph option -all. A shortcut for - attributes
-operations -visibility -types. The
default value is true.
|
| maven.dotuml.hide | Yes | UmlGraph option -hide. A list of (unqualified) class names to hide from the output graph. Unset by default. |
| maven.dotuml.singlepackage | Yes | If set to true, generates a single UML class diagram for the component. True by default. |
| Property | Optional? | Description |
|---|---|---|
| maven.dotuml.nodefillcolor | Yes | UmlGraph option -nodefillcolor. Specifies the color to fill the shapes. The default color is white. |
| Note | Yes | Specify color as symbolic name (like in X-Windows) - e.g. "blue", as HSV triple of values ranging from 0 to 1 - e.g. ".13 .9 1", or as RGB hex digits prefixed by # - e.g. "#ff8020". |
| maven.dotuml.nodefontname | Yes | UmlGraph option -nodefontname. Specifies the font to use inside nodes. The default value is LucidaSansRegular. |
| maven.dotuml.nodefontabstractname | Yes | UmlGraph option -nodefontabstractname. Specifies the font to use inside abstract class nodes. The default value is LucidaSansOblique. |
| maven.dotuml.nodefontsize | Yes | UmlGraph option -nodefontsize. Specifies the font size to use inside nodes. Unset by default. |
| maven.dotuml.nodefontcolor | Yes | UmlGraph option -nodefontcolor. Specifies the font color to use inside nodes. Default is black. |
| maven.dotuml.edgefontname | Yes | UmlGraph option -edgefontname. Specifies the font to use for edge labels. The default value is LucidaSansRegular. |
| maven.dotuml.edgefontsize | Yes | UmlGraph option -edgefontsize. Specifies the font size to use for edge labels. Unset by default. |
| maven.dotuml.edgefontcolor | Yes | UmlGraph option -edgefontcolor. Specifies the font color to use for edge labels. Default is black. |
| maven.dotuml.edgecolor | Yes | UmlGraph option -edgecolor. Specifies the color to use for drawing edges. Default is black. |
| maven.dotuml.bgcolor | Yes | UmlGraph option -bgcolor. Specifies the color to use for the graph's background. Default is white. |
| maven.dotuml.outputencoding | Yes | Needed to support the guillaume characters used in interfaces and stereotypes. Default is utf8. |
| maven.dotuml.noguillemot | Yes | If defined (regardless of the value), disables the use of guillemot characters in special names like interfaces and stereotypes. |
| Property | Optional? | Description |
|---|---|---|
| maven.dotuml.destdir | Yes |
Specifies the destination directory to use for the generated
graph. The default value is
${maven.docs.dest}/dotuml. This directory
setting is combined with the file name
${maven.dotuml.dotout} to produce a value
and the UmlGraph -output option, also settable via
${maven.dotuml.output}.
|
| maven.dotuml.generate.report | Yes | This property is a switch to control whether the report.xml file should be included in the reports section or not. Default is to false. |
| maven.dotuml.ignore.packages | Yes | With the help of this property packages can be excluded from processing. Packages must be specified as com/sun/jdk and delimited with " ", ",", or ";". Wildcards are not allowed. |
| maven.dotuml.image.map | Yes | This property specifies whether an image map should be generated. This feature is only used with .png and .gif diagrams. Default is true. |
| maven.dotuml.javadoc.link | Yes | Generate a link to JavaDoc packages (in daigram-per-package mode). Default is set to true. |
| maven.dotuml.xref.link | Yes | Generate a link to XRef packages (in daigram-per-package mode). Default is set to true. |
| maven.dotuml.svg.width | Yes | Specifies the width of .svg images in the html page. Default is set to 800. |
| maven.dotuml.svg.height | Yes | Specifies the height of .svg images in the html page. Default is set to 600. |
| maven.dotuml.apidocroot | Yes | Specifies the root to the apidocs. Default is set to ${maven.javadoc.destdir}. |
| maven.dotuml.apidocmap | Yes | File with a map of regular expressions to URL roots to resolve external classes. |
| Note | Yes | If none of sourcefiles, packagenames or packagelist are specified, this plugin attempts to find all packages and produces one diagram for each of them. |