Maven Site Plugin 3 - Checkstyle Results

Checkstyle Results

The following document contains the results of Checkstyle.

Summary

Files	Infos	Warnings	Errors
19	6	184	14

Files

Files	I	W	E
org/apache/maven/plugins/site/AbstractDeployMojo.java	0	4	2
org/apache/maven/plugins/site/AbstractSiteMojo.java	0	4	2
org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java	0	14	4
org/apache/maven/plugins/site/CategorySummaryDocumentRenderer.java	0	12	0
org/apache/maven/plugins/site/EffectiveSiteMojo.java	0	2	0
org/apache/maven/plugins/site/ReportDocumentRenderer.java	0	12	2
org/apache/maven/plugins/site/SiteDescriptorArtifactMetadata.java	0	20	0
org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java	0	2	4
org/apache/maven/plugins/site/SiteJarMojo.java	0	8	0
org/apache/maven/plugins/site/SiteRunMojo.java	0	8	0
org/apache/maven/plugins/site/SiteStageMojo.java	0	4	0
org/apache/maven/plugins/site/wagon/PathUtils.java	0	14	0
org/apache/maven/plugins/site/wagon/repository/Repository.java	0	48	0
org/apache/maven/plugins/site/webapp/DoxiaBean.java	0	18	0
org/apache/maven/plugins/site/webapp/DoxiaFilter.java	6	14	0

Rules

Rules	Violations	Severity
FileLength	0	Error
RegexpHeader headerFile: `"target/checkstyle-header.txt"`	0	Error
FileTabCharacter eachLine: `"true"`	0	Error
LeftCurly option: `"nl"`	0	Error
RightCurly option: `"alone"`	0	Error
LineLength ignorePattern: `"@version\|@see\|@todo\|TODO"` max: `"120"`	14	Error
MemberName	0	Error
JavadocMethod scope: `"protected"`	170	Warning
JavadocType allowUnknownTags: `"true"` scope: `"protected"`	0	Error
JavadocVariable scope: `"protected"`	6	Info
ConstantName	0	Error
LocalFinalVariableName	0	Error
LocalVariableName	0	Error
MethodName	0	Error
PackageName	0	Error
ParameterName	0	Error
StaticVariableName	0	Error
TypeName	0	Error
AvoidStarImport	0	Error
IllegalImport	0	Error
RedundantImport	0	Error
UnusedImports	0	Error
MethodLength	0	Error
ParameterNumber	0	Error
EmptyForIteratorPad option: `"space"`	0	Error
OperatorWrap	0	Error
ParenPad option: `"space"`	0	Error
WhitespaceAfter	0	Error
WhitespaceAround	0	Error
ModifierOrder	0	Error
RedundantModifier	0	Error
AvoidNestedBlocks	0	Error
EmptyBlock option: `"text"`	0	Error
NeedBraces	0	Error
DoubleCheckedLocking	0	Error
EmptyStatement	0	Error
EqualsHashCode	0	Error
HiddenField ignoreConstructorParameter: `"true"` ignoreSetter: `"true"`	14	Warning
IllegalInstantiation	0	Error
InnerAssignment	0	Error
MagicNumber ignoreNumbers: `"-4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 32, 64, 100, 128, 256, 512, 1000, 1024"`	0	Error
MissingSwitchDefault	0	Error
RedundantThrows	0	Error
SimplifyBooleanExpression	0	Error
SimplifyBooleanReturn	0	Error
InterfaceIsType	0	Error
VisibilityModifier packageAllowed: `"true"` protectedAllowed: `"true"`	0	Error
UpperEll	0	Error

Details

org/apache/maven/plugins/site/AbstractDeployMojo.java

Violation	Message	Line
	Expected @throws tag for 'MojoExecutionException'.	213
	'inputDirectory' hides a field.	389
	Line is longer than 120 characters.	612
	Expected @throws tag for 'MojoExecutionException'.	213
	'inputDirectory' hides a field.	389
	Line is longer than 120 characters.	612

org/apache/maven/plugins/site/AbstractSiteMojo.java

Violation	Message	Line
	Expected an @return tag.	127
	Missing a Javadoc comment.	132
	Line is longer than 120 characters.	140
	Expected an @return tag.	127
	Missing a Javadoc comment.	132
	Line is longer than 120 characters.	140

org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java

Violation	Message	Line
	Missing a Javadoc comment.	215
	Missing a Javadoc comment.	249
	'reports' hides a field.	382
	Line is longer than 120 characters.	409
	'reports' hides a field.	423
	Line is longer than 120 characters.	439
	Missing a Javadoc comment.	439
	'reports' hides a field.	439
	Missing a Javadoc comment.	496
	Missing a Javadoc comment.	215
	Missing a Javadoc comment.	249
	'reports' hides a field.	382
	Line is longer than 120 characters.	409
	'reports' hides a field.	423
	Line is longer than 120 characters.	439
	Missing a Javadoc comment.	439
	'reports' hides a field.	439
	Missing a Javadoc comment.	496

org/apache/maven/plugins/site/CategorySummaryDocumentRenderer.java

Violation	Message	Line
	Missing a Javadoc comment.	64
	Missing a Javadoc comment.	70
	Missing a Javadoc comment.	82
	Missing a Javadoc comment.	180
	Missing a Javadoc comment.	185
	Missing a Javadoc comment.	190
	Missing a Javadoc comment.	64
	Missing a Javadoc comment.	70
	Missing a Javadoc comment.	82
	Missing a Javadoc comment.	180
	Missing a Javadoc comment.	185
	Missing a Javadoc comment.	190

org/apache/maven/plugins/site/EffectiveSiteMojo.java

Violation	Message	Line
	Missing a Javadoc comment.	193
	Missing a Javadoc comment.	193

org/apache/maven/plugins/site/ReportDocumentRenderer.java

Violation	Message	Line
	Line is longer than 120 characters.	71
	Missing a Javadoc comment.	71
	'report' hides a field.	99
	Missing a Javadoc comment.	197
	Missing a Javadoc comment.	328
	Missing a Javadoc comment.	333
	Missing a Javadoc comment.	338
	Line is longer than 120 characters.	71
	Missing a Javadoc comment.	71
	'report' hides a field.	99
	Missing a Javadoc comment.	197
	Missing a Javadoc comment.	328
	Missing a Javadoc comment.	333
	Missing a Javadoc comment.	338

org/apache/maven/plugins/site/SiteDescriptorArtifactMetadata.java

Violation	Message	Line
	Missing a Javadoc comment.	50
	Missing a Javadoc comment.	58
	Missing a Javadoc comment.	63
	Missing a Javadoc comment.	73
	Missing a Javadoc comment.	97
	Missing a Javadoc comment.	102
	Missing a Javadoc comment.	107
	Missing a Javadoc comment.	112
	Missing a Javadoc comment.	117
	Missing a Javadoc comment.	126
	Missing a Javadoc comment.	50
	Missing a Javadoc comment.	58
	Missing a Javadoc comment.	63
	Missing a Javadoc comment.	73
	Missing a Javadoc comment.	97
	Missing a Javadoc comment.	102
	Missing a Javadoc comment.	107
	Missing a Javadoc comment.	112
	Missing a Javadoc comment.	117
	Missing a Javadoc comment.	126

org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java

Violation	Message	Line
	Line is longer than 120 characters.	39
	Line is longer than 120 characters.	42
	Missing a Javadoc comment.	71
	Line is longer than 120 characters.	39
	Line is longer than 120 characters.	42
	Missing a Javadoc comment.	71

org/apache/maven/plugins/site/SiteJarMojo.java

Violation	Message	Line
	Expected @throws tag for 'MojoExecutionException'.	120
	Expected @throws tag for 'MojoFailureException'.	120
	Missing a Javadoc comment.	159
	Missing a Javadoc comment.	164
	Expected @throws tag for 'MojoExecutionException'.	120
	Expected @throws tag for 'MojoFailureException'.	120
	Missing a Javadoc comment.	159
	Missing a Javadoc comment.	164

org/apache/maven/plugins/site/SiteRunMojo.java

Violation	Message	Line
	Expected @throws tag for 'MojoExecutionException'.	82
	Expected @throws tag for 'MojoFailureException'.	82
	Missing a Javadoc comment.	230
	Missing a Javadoc comment.	235
	Expected @throws tag for 'MojoExecutionException'.	82
	Expected @throws tag for 'MojoFailureException'.	82
	Missing a Javadoc comment.	230
	Missing a Javadoc comment.	235

org/apache/maven/plugins/site/SiteStageMojo.java

Violation	Message	Line
	Missing a Javadoc comment.	88
	Missing a Javadoc comment.	100
	Missing a Javadoc comment.	88
	Missing a Javadoc comment.	100

org/apache/maven/plugins/site/wagon/PathUtils.java

Violation	Message	Line
	Expected @param tag for 'path'.	49
	Expected @param tag for 'path'.	61
	Missing a Javadoc comment.	67
	Expected @param tag for 'url'.	235
	Missing a Javadoc comment.	437
	Missing a Javadoc comment.	457
	Missing a Javadoc comment.	474
	Expected @param tag for 'path'.	49
	Expected @param tag for 'path'.	61
	Missing a Javadoc comment.	67
	Expected @param tag for 'url'.	235
	Missing a Javadoc comment.	437
	Missing a Javadoc comment.	457
	Missing a Javadoc comment.	474

org/apache/maven/plugins/site/wagon/repository/Repository.java

Violation	Message	Line
	Missing a Javadoc comment.	80
	Missing a Javadoc comment.	97
	Missing a Javadoc comment.	102
	Missing a Javadoc comment.	118
	Missing a Javadoc comment.	123
	Missing a Javadoc comment.	128
	Missing a Javadoc comment.	133
	Missing a Javadoc comment.	138
	'username' hides a field.	154
	'password' hides a field.	159
	Missing a Javadoc comment.	175
	Missing a Javadoc comment.	202
	Missing a Javadoc comment.	211
	Missing a Javadoc comment.	220
	Missing a Javadoc comment.	237
	Missing a Javadoc comment.	242
	Missing a Javadoc comment.	247
	Missing a Javadoc comment.	252
	Missing a Javadoc comment.	257
	Missing a Javadoc comment.	262
	Missing a Javadoc comment.	270
	Missing a Javadoc comment.	299
	Missing a Javadoc comment.	304
	Missing a Javadoc comment.	309
	Missing a Javadoc comment.	80
	Missing a Javadoc comment.	97
	Missing a Javadoc comment.	102
	Missing a Javadoc comment.	118
	Missing a Javadoc comment.	123
	Missing a Javadoc comment.	128
	Missing a Javadoc comment.	133
	Missing a Javadoc comment.	138
	'username' hides a field.	154
	'password' hides a field.	159
	Missing a Javadoc comment.	175
	Missing a Javadoc comment.	202
	Missing a Javadoc comment.	211
	Missing a Javadoc comment.	220
	Missing a Javadoc comment.	237
	Missing a Javadoc comment.	242
	Missing a Javadoc comment.	247
	Missing a Javadoc comment.	252
	Missing a Javadoc comment.	257
	Missing a Javadoc comment.	262
	Missing a Javadoc comment.	270
	Missing a Javadoc comment.	299
	Missing a Javadoc comment.	304
	Missing a Javadoc comment.	309

org/apache/maven/plugins/site/webapp/DoxiaBean.java

Violation	Message	Line
	Expected @param tag for 'context'.	47
	Expected @param tag for 'documents'.	47
	Expected @param tag for 'generatedSiteDirectory'.	48
	Missing a Javadoc comment.	55
	Missing a Javadoc comment.	60
	Missing a Javadoc comment.	65
	Missing a Javadoc comment.	70
	Missing a Javadoc comment.	75
	Missing a Javadoc comment.	80
	Expected @param tag for 'context'.	47
	Expected @param tag for 'documents'.	47
	Expected @param tag for 'generatedSiteDirectory'.	48
	Missing a Javadoc comment.	55
	Missing a Javadoc comment.	60
	Missing a Javadoc comment.	65
	Missing a Javadoc comment.	70
	Missing a Javadoc comment.	75
	Missing a Javadoc comment.	80

org/apache/maven/plugins/site/webapp/DoxiaFilter.java

Violation	Message	Line
	Missing a Javadoc comment.	51
	Missing a Javadoc comment.	53
	Missing a Javadoc comment.	55
	Expected @param tag for 'filterConfig'.	66
	Expected @throws tag for 'ServletException'.	67
	Expected @param tag for 'servletRequest'.	81
	Expected @param tag for 'servletResponse'.	81
	Expected @param tag for 'filterChain'.	81
	Expected @throws tag for 'IOException'.	82
	Expected @throws tag for 'ServletException'.	82
	Missing a Javadoc comment.	51
	Missing a Javadoc comment.	53
	Missing a Javadoc comment.	55
	Expected @param tag for 'filterConfig'.	66
	Expected @throws tag for 'ServletException'.	67
	Expected @param tag for 'servletRequest'.	81
	Expected @param tag for 'servletResponse'.	81
	Expected @param tag for 'filterChain'.	81
	Expected @throws tag for 'IOException'.	82
	Expected @throws tag for 'ServletException'.	82

Overview

Configuration

Examples

Project Documentation

Maven Projects

ASF

Checkstyle Results

Summary

Files

Rules

Details

org/apache/maven/plugins/site/AbstractDeployMojo.java

org/apache/maven/plugins/site/AbstractSiteMojo.java

org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java

org/apache/maven/plugins/site/CategorySummaryDocumentRenderer.java

org/apache/maven/plugins/site/EffectiveSiteMojo.java

org/apache/maven/plugins/site/ReportDocumentRenderer.java

org/apache/maven/plugins/site/SiteDescriptorArtifactMetadata.java

org/apache/maven/plugins/site/SiteDescriptorAttachMojo.java

org/apache/maven/plugins/site/SiteJarMojo.java

org/apache/maven/plugins/site/SiteRunMojo.java

org/apache/maven/plugins/site/SiteStageMojo.java

org/apache/maven/plugins/site/wagon/PathUtils.java

org/apache/maven/plugins/site/wagon/repository/Repository.java

org/apache/maven/plugins/site/webapp/DoxiaBean.java

org/apache/maven/plugins/site/webapp/DoxiaFilter.java