springbeandoc:springbeandoc

Note:This goal should be used as a Maven report.

Full name:

org.codehaus.mojo:maven-springbeandoc-plugin:1.0.8-SNAPSHOT:springbeandoc

Description:

Spring BeanDoc report generator that can be used as a Maven 2 plugin or a Maven 2 site report.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name Type Since Description
executable File - GraphViz executable location; visualization (images) will be generated only if you install this program and set this property to the executable dot (dot.exe on Win).
graphsOutputType String - Graph output types. Default is png. Possible values: png, jpg, gif, svg.
Default value is: png.
outputDirectory File - Base output directory for reports.

Optional Parameters

Name Type Since Description
colourBeans ColourBean[] - Specify colours for patterns based on the bean name (id) or the bean's fully qualified class name.
cssUrl URL - Stylesheet URL to use for generated report.
defaultFillColour String - Specify the default colour for beans.
footer String - Documentation footer used in the HTML output.
ignoreBeans String[] - Ignore any number of beans based on either their id's/names or class names by specifying one or more Regular Expressions.
includes String[] - Specifies the names filter of the source files to be used by BeanDoc. This setting only applies to sourceDirectories parameter. Defaults to '**\/*.xml'.
javadocLocations JavadocLocation[] - List of JavadocLocation objects.
locale String - I18N localization used in the HTML output.
mergeProxies MergeProxy[] - Merge proxies and targets beans where the target bean is not modelled as an anonymous inner bean.
rankBeans String[] - Rank beans by defining one or more Regular Expression which groups the matching beans, regardless of any references between them. If a bean match more then one pattern, all matching pattern will share the same rank in the graph.
resources String[] - Set of input resources. Resources are standard Spring resources. Note that beandoc defaults to FILE system resources, not classpath resources if no qualifier is listed.
sourceDirectories File[] - Set of source directories.
title String - Documentation title used in the HTML output.
validate boolean - You can have the XML parser not bother to validate the input files against the DTD/XSD if you so wish. True by default.
Default value is: true.

Parameter Details

colourBeans:

Specify colours for patterns based on the bean name (id) or the bean's fully qualified class name.
  • Type: org.codehaus.mojo.springbeandoc.ColourBean[]
  • Required: No

cssUrl:

Stylesheet URL to use for generated report.
  • Type: java.net.URL
  • Required: No

defaultFillColour:

Specify the default colour for beans.
  • Type: java.lang.String
  • Required: No

executable:

GraphViz executable location; visualization (images) will be generated only if you install this program and set this property to the executable dot (dot.exe on Win).
  • Type: java.io.File
  • Required: Yes

footer:

Documentation footer used in the HTML output.
  • Type: java.lang.String
  • Required: No

graphsOutputType:

Graph output types. Default is png. Possible values: png, jpg, gif, svg.
  • Type: java.lang.String
  • Required: Yes
  • Default: png

ignoreBeans:

Ignore any number of beans based on either their id's/names or class names by specifying one or more Regular Expressions.
  • Type: java.lang.String[]
  • Required: No

includes:

Specifies the names filter of the source files to be used by BeanDoc. This setting only applies to sourceDirectories parameter. Defaults to '**\/*.xml'.
  • Type: java.lang.String[]
  • Required: No

javadocLocations:

List of JavadocLocation objects.
  • Type: org.codehaus.mojo.springbeandoc.JavadocLocation[]
  • Required: No

locale:

I18N localization used in the HTML output.
  • Type: java.lang.String
  • Required: No

mergeProxies:

Merge proxies and targets beans where the target bean is not modelled as an anonymous inner bean.
  • Type: org.codehaus.mojo.springbeandoc.MergeProxy[]
  • Required: No

outputDirectory:

Base output directory for reports.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.reporting.outputDirectory}

rankBeans:

Rank beans by defining one or more Regular Expression which groups the matching beans, regardless of any references between them. If a bean match more then one pattern, all matching pattern will share the same rank in the graph.
  • Type: java.lang.String[]
  • Required: No

resources:

Set of input resources. Resources are standard Spring resources. Note that beandoc defaults to FILE system resources, not classpath resources if no qualifier is listed.
  • Type: java.lang.String[]
  • Required: No

sourceDirectories:

Set of source directories.
  • Type: java.io.File[]
  • Required: No

title:

Documentation title used in the HTML output.
  • Type: java.lang.String
  • Required: No

validate:

You can have the XML parser not bother to validate the input files against the DTD/XSD if you so wish. True by default.
  • Type: boolean
  • Required: No
  • Default: true