Maven Author Plugin - Maven Author Plugin's properties

Maven Author Plugin's properties

Generic properties

Property	Default	Description
maven.author.includes	*/.java	List of files to include in the report.
maven.author.excludes		List of files to exclude from the report.
maven.author.resolvers	org.apache.maven.author.resolver.JavadocAuthorResolver,org.apache.maven.author.resolver.SCMAuthorResolver	Comma-separated list of AuthorResolver(s) to use : an AuthorResolver resolve the author(s) of a file. Current existing resolvers are : org.apache.maven.author.resolver.JavadocAuthorResolver : uses author's javadoc tags to resolve the author(s). org.apache.maven.author.resolver.SCMAuthorResolver : uses a SCM to resolve the author(s) - NOT YET IMPLEMENTED.

Property

Default

Description

maven.author.includes

**/*.java

List of files to include in the report.

maven.author.excludes

List of files to exclude from the report.

maven.author.resolvers

org.apache.maven.author.resolver.JavadocAuthorResolver,org.apache.maven.author.resolver.SCMAuthorResolver

Comma-separated list of AuthorResolver(s) to use : an AuthorResolver resolve the author(s) of a file.

Current existing resolvers are :

org.apache.maven.author.resolver.JavadocAuthorResolver : uses author's javadoc tags to resolve the author(s).
org.apache.maven.author.resolver.SCMAuthorResolver : uses a SCM to resolve the author(s) - NOT YET IMPLEMENTED.

HTML report properties

Property	Default	Description
maven.author.template.file	${plugin.resources}/templates/author.jsl	Location of JSL template to generate the main report xdoc file.
maven.author.unknown	???	Label to use in the report when author was unresolvable.
maven.author.aggregator.result.na	-	Label to use in the report when datas for an aggregator are not available.
Colors and images used when generating the progress bar for values shown as percentage:
maven.author.report.bar.left	green	HTML color for left bar.
maven.author.report.bar.right	red	HTML color for right bar.
maven.author.report.bar.image	images/trans.gif	Image to set cells with (should be transparent).
maven.author.report.bar.height	10	Height of image to set cells with.
maven.author.report.bar.border	0	Border of image to set cells with.

Aggregators properties

Generic properties

Property	Default	Description
maven.author.aggregators.dir	${plugin.resources}/aggregators	Location of default author aggregators.
maven.author.aggregators	csall,cserrors,cswarnings,csinfos,fbviolations,pmdviolations,lint4jwarnings,javancssncss,javancssfunctions,jcoveragelipc,coberturalipc,emmalipc,clovertpc,tasklist	Comma-separated list of aggregators to use.

Properties for the Checkstyle error/warning/info aggregator (all errors/warnings/infos)

Property	Default	Description
maven.author.aggregator.csall.script	${maven.author.aggregators.dir}/csall.jelly
maven.author.aggregator.csall.artifact	${maven.build.dir}/checkstyle/checkstyle-raw-report.xml
maven.author.aggregator.csall.label	CS err/warn/inf
maven.author.aggregator.csall.description	Number of Checkstyle errors, warnings and infos
maven.author.aggregator.csall.report	checkstyle/all.html
maven.author.aggregator.csall.percent	false

Properties for the Checkstyle error aggregator (only errors)

Property	Default	Description
maven.author.aggregator.cserrors.script	${maven.author.aggregators.dir}/cserrors.jelly
maven.author.aggregator.cserrors.artifact	${maven.build.dir}/checkstyle/checkstyle-raw-report.xml
maven.author.aggregator.cserrors.label	CS errors
maven.author.aggregator.cserrors.description	Number of Checkstyle errors
maven.author.aggregator.cserrors.report	checkstyle/error.html
maven.author.aggregator.cserrors.percent	false

Properties for the Checkstyle warning aggregator (only warnings)

Property	Default	Description
maven.author.aggregator.cswarnings.script	${maven.author.aggregators.dir}/cswarnings.jelly
maven.author.aggregator.cswarnings.artifact	${maven.build.dir}/checkstyle/checkstyle-raw-report.xml
maven.author.aggregator.cswarnings.label	CS warnings
maven.author.aggregator.cswarnings.description	Number of Checkstyle warnings
maven.author.aggregator.cswarnings.report	checkstyle/warning.html
maven.author.aggregator.cswarnings.percent	false

Properties for the Checkstyle info aggregator (only infos)

Property	Default	Description
maven.author.aggregator.cswarnings.script	${maven.author.aggregators.dir}/csinfos.jelly
maven.author.aggregator.cswarnings.artifact	${maven.build.dir}/checkstyle/checkstyle-raw-report.xml
maven.author.aggregator.cswarnings.label	CS infos
maven.author.aggregator.cswarnings.description	Number of Checkstyle infos
maven.author.aggregator.cswarnings.report	checkstyle/info.html
maven.author.aggregator.cswarnings.percent	false

Properties for the FindBugs violations aggregator

Property	Default	Description
maven.author.aggregator.fbviolations.script	${maven.author.aggregators.dir}/fbviolations.jelly
maven.author.aggregator.fbviolations.artifact	${maven.build.dir}/findbugs-raw-report.xml
maven.author.aggregator.fbviolations.label	FindBugs violations
maven.author.aggregator.fbviolations.description	Number of FindBugs violations
maven.author.aggregator.fbviolations.report	findbugs-report.html
maven.author.aggregator.fbviolations.percent	false

Properties for the PMD violations aggregator

Property	Default	Description
maven.author.aggregator.pmdviolations.script	${maven.author.aggregators.dir}/pmdviolations.jelly
maven.author.aggregator.pmdviolations.artifact	${maven.build.dir}/pmd-raw-report.xml
maven.author.aggregator.pmdviolations.label	PMD violations
maven.author.aggregator.pmdviolations.description	Number of PMD violations
maven.author.aggregator.pmdviolations.report	pmd-report.html
maven.author.aggregator.pmdviolations.percent	false

Properties for the Lint4j warnings aggregator

Property	Default	Description
maven.author.aggregator.lint4jwarnings.script	${maven.author.aggregators.dir}/lint4jwarnings.jelly
maven.author.aggregator.lint4jwarnings.artifact	${maven.build.dir}/lint4j-raw-report.xml
maven.author.aggregator.lint4jwarnings.label	Lint4j warnings
maven.author.aggregator.lint4jwarnings.description	Number of Lint4j warnings
maven.author.aggregator.lint4jwarnings.report	lint4j-report.html
maven.author.aggregator.lint4jwarnings.percent	false

Properties for the JavaNCSS number of non-commented source statements aggregator

Property	Default	Description
maven.author.aggregator.javancssncss.script	${maven.author.aggregators.dir}/javancssncss.jelly
maven.author.aggregator.javancssncss.artifact	${maven.build.dir}/javancss-raw-report.xml
maven.author.aggregator.javancssncss.label	JavaNCSS NCSS
maven.author.aggregator.javancssncss.description	Number of JavaNCSS non-commented source statements
maven.author.aggregator.javancssncss.report	javancss-report.html
maven.author.aggregator.javancssncss.percent	false

Properties for the JavaNCSS number of functions aggregator

Property	Default	Description
maven.author.aggregator.javancssfunctions.script	${maven.author.aggregators.dir}/javancssfunctions.jelly
maven.author.aggregator.javancssfunctions.artifact	${maven.build.dir}/javancss-raw-report.xml
maven.author.aggregator.javancssfunctions.label	JavaNCSS functions
maven.author.aggregator.javancssfunctions.description	Number of JavaNCSS functions
maven.author.aggregator.javancssfunctions.report	javancss-report.html
maven.author.aggregator.javancssfunctions.percent	false

Properties for the JCoverage covered lines percent aggregator

Property	Default	Description
maven.author.aggregator.jcoveragelipc.script	${maven.author.aggregators.dir}/jcoveragelipc.jelly
maven.author.aggregator.jcoveragelipc.artifact	${maven.build.dir}/jcoverage/coverage.xml
maven.author.aggregator.jcoveragelipc.label	JCoverage %lines
maven.author.aggregator.jcoveragelipc.description	JCoverage percentage of covered lines
maven.author.aggregator.jcoveragelipc.report	jcoverage/index.html
maven.author.aggregator.jcoveragelipc.percent	true

Properties for the Cobertura covered lines percent aggregator

Property	Default	Description
maven.author.aggregator.coberturalipc.script	${maven.author.aggregators.dir}/coberturalipc.jelly
maven.author.aggregator.coberturalipc.artifact	${maven.docs.dest}/cobertura/coverage.xml
maven.author.aggregator.coberturalipc.label	Cobertura %lines
maven.author.aggregator.coberturalipc.description	Cobertura percentage of covered lines
maven.author.aggregator.coberturalipc.report	cobertura/index.html
maven.author.aggregator.coberturalipc.percent	true

Properties for the Emma covered lines percent aggregator

Property	Default	Description
maven.author.aggregator.emmalipc.script	${maven.author.aggregators.dir}/emmalipc.jelly
maven.author.aggregator.emmalipc.artifact	${maven.build.dir}/coverage.xml
maven.author.aggregator.emmalipc.label	Emma %lines
maven.author.aggregator.emmalipc.description	Emma percentage of covered lines
maven.author.aggregator.emmalipc.report	coverage/index.html
maven.author.aggregator.emmalipc.percent	true

Properties for the Clover TPC aggregator (TPC = Total Percent Coverage)

Property	Default	Description
maven.author.aggregator.clovertpc.script	${maven.author.aggregators.dir}/clovertpc.jelly
maven.author.aggregator.clovertpc.artifact	${maven.build.dir}/clover.xml
maven.author.aggregator.clovertpc.label	Clover TPC
maven.author.aggregator.clovertpc.description	Clover Total Percent Coverage
maven.author.aggregator.clovertpc.report	clover/index.html
maven.author.aggregator.clovertpc.percent	true

Properties for the Tasks List aggregator

Property	Default	Description
maven.author.aggregator.tasklist.script	${maven.author.aggregators.dir}/tasklist.jelly
maven.author.aggregator.tasklist.artifact	${maven.build.dir}/generated-xdocs/task-list.xml
maven.author.aggregator.tasklist.label	All Tasks
maven.author.aggregator.tasklist.description	Total number of task definition (@todo tag)
maven.author.aggregator.tasklist.report	task-list.html
maven.author.aggregator.tasklist.percent	false

Overview

Project Documentation

Legend

Maven Author Plugin's properties

Generic properties

HTML report properties

Aggregators properties

Generic properties

Properties for the Checkstyle error/warning/info aggregator (all errors/warnings/infos)

Properties for the Checkstyle error aggregator (only errors)

Properties for the Checkstyle warning aggregator (only warnings)

Properties for the Checkstyle info aggregator (only infos)

Properties for the FindBugs violations aggregator

Properties for the PMD violations aggregator

Properties for the Lint4j warnings aggregator

Properties for the JavaNCSS number of non-commented source statements aggregator

Properties for the JavaNCSS number of functions aggregator

Properties for the JCoverage covered lines percent aggregator

Properties for the Cobertura covered lines percent aggregator

Properties for the Emma covered lines percent aggregator

Properties for the Clover TPC aggregator (TPC = Total Percent Coverage)

Properties for the Tasks List aggregator