Maven JXR - Checkstyle Results

Checkstyle Results

The following document contains the results of Checkstyle.

Summary

Files	Infos	Warnings	Errors
17	0	109	39

Files

Files	W	E
org/apache/maven/jxr/DirectoryIndexer.java	6	0
org/apache/maven/jxr/JXR.java	23	0
org/apache/maven/jxr/JavaCodeTransform.java	17	37
org/apache/maven/jxr/JxrException.java	1	0
org/apache/maven/jxr/ant/DirectoryScanner.java	1	0
org/apache/maven/jxr/log/Log.java	4	0
org/apache/maven/jxr/log/VelocityLogger.java	2	0
org/apache/maven/jxr/pacman/ClassType.java	5	0
org/apache/maven/jxr/pacman/FileManager.java	6	0
org/apache/maven/jxr/pacman/ImportType.java	4	0
org/apache/maven/jxr/pacman/JavaFile.java	12	0
org/apache/maven/jxr/pacman/JavaFileImpl.java	3	0
org/apache/maven/jxr/pacman/PackageManager.java	11	0
org/apache/maven/jxr/pacman/PackageType.java	5	0
org/apache/maven/jxr/util/SimpleWordTokenizer.java	3	1
org/apache/maven/jxr/util/StringEntry.java	6	1

Rules

Rules	Violations	Severity
FileLength	0	Error
RegexpHeader headerFile: `"target/checkstyle-header.txt"`	1	Error
FileTabCharacter eachLine: `"true"`	2	Error
LeftCurly option: `"nl"`	1	Error
RightCurly option: `"alone"`	1	Error
LineLength max: `"120"` ignorePattern: `"@version\|@see\|@todo\|TODO"`	2	Error
MemberName	0	Error
JavadocMethod scope: `"protected"`	93	Warning
JavadocType allowUnknownTags: `"true"` scope: `"protected"`	0	Error
JavadocVariable scope: `"protected"`	0	Info
ConstantName	0	Error
LocalFinalVariableName	1	Error
LocalVariableName	2	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	2	Error
EmptyForIteratorPad option: `"space"`	0	Error
OperatorWrap	2	Error
ParenPad option: `"space"`	0	Error
WhitespaceAfter	0	Error
WhitespaceAround	0	Error
ModifierOrder	0	Error
RedundantModifier	17	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"`	16	Warning
IllegalInstantiation	0	Error
InnerAssignment	2	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"`	4	Error
MissingSwitchDefault	0	Error
RedundantThrows	0	Error
SimplifyBooleanExpression	2	Error
SimplifyBooleanReturn	0	Error
InterfaceIsType	0	Error
VisibilityModifier packageAllowed: `"true"` protectedAllowed: `"true"`	0	Error
UpperEll	0	Error

Details

org/apache/maven/jxr/DirectoryIndexer.java

Violation	Message	Line
	Expected an @return tag.	121
	Expected an @return tag.	140
	Expected an @return tag.	161
	Expected an @return tag.	182
	Expected an @return tag.	203
	Expected @param tag for 'log'.	213

org/apache/maven/jxr/JXR.java

Violation	Message	Line
	Expected @param tag for 'packageManager'.	98
	Expected @param tag for 'source'.	98
	Expected @param tag for 'bottom'.	98
	Expected @throws tag for 'IOException'.	99
	Expected @param tag for 'dest'.	176
	Expected @param tag for 'locale'.	184
	Expected @param tag for 'inputEncoding'.	192
	Expected @param tag for 'outputEncoding'.	200
	Expected @param tag for 'javadocLinkDir'.	208
	Expected @param tag for 'transformer'.	217
	Expected @param tag for 'revision'.	225
	Expected @param tag for 'log'.	233
	Expected @param tag for 'sourceDirs'.	247
	Expected @param tag for 'templateDir'.	247
	Expected @param tag for 'windowTitle'.	247
	Expected @param tag for 'docTitle'.	247
	Expected @param tag for 'bottom'.	247
	Expected @throws tag for 'IOException'.	248
	Expected @throws tag for 'JxrException'.	248
	'dest' hides a field.	295
	'dest' hides a field.	325
	Missing a Javadoc comment.	406
	Missing a Javadoc comment.	412

org/apache/maven/jxr/JavaCodeTransform.java

Violation	Message	Line
	Line does not match expected header line of '^ \* Licensed to the Apache Software Foundation $ASF$ under one\s*$'.	4
	Unused Javadoc tag.	269
	'outputEncoding' hides a field.	273
	Line is longer than 120 characters.	281
	Line contains a tab character.	300
	Line contains a tab character.	304
	Unused Javadoc tag.	335
	More than 7 parameters.	361
	'locale' hides a field.	361
	'inputEncoding' hides a field.	361
	'outputEncoding' hides a field.	362
	'javadocLinkDir' hides a field.	362
	'revision' hides a field.	362
	Expected @throws tag for 'IOException'.	363
	Line is longer than 120 characters.	384
	More than 7 parameters.	411
	'sourcefile' hides a field.	411
	'destfile' hides a field.	411
	'locale' hides a field.	411
	'inputEncoding' hides a field.	411
	'outputEncoding' hides a field.	412
	'javadocLinkDir' hides a field.	412
	'revision' hides a field.	412
	Expected @throws tag for 'IOException'.	413
	Redundant 'final' modifier.	706
	Redundant 'final' modifier.	729
	':' should be on a new line.	737
	':' should be on a new line.	739
	Redundant 'final' modifier.	784
	Inner assignments should be avoided.	794
	Redundant 'final' modifier.	815
	Inner assignments should be avoided.	827
	'}' should be alone on a line.	834
	'{' should be on a new line.	834
	Redundant 'final' modifier.	860
	Redundant 'final' modifier.	908
	Name 'CLASS_KEYWORD' must match pattern '^[a-z][a-zA-Z0-9]*$'.	910
	'65' is a magic number.	924
	'90' is a magic number.	924
	'97' is a magic number.	924
	'122' is a magic number.	924
	Redundant 'final' modifier.	968
	Redundant 'final' modifier.	988
	Redundant 'final' modifier.	1015
	Redundant 'final' modifier.	1104
	Redundant 'final' modifier.	1156
	Redundant 'final' modifier.	1179
	Name 'fqpn_package' must match pattern '^[a-z][a-zA-Z0-9]*$'.	1250
	Name 'fqpn_class' must match pattern '^[a-z][a-zA-Z0-9]*$'.	1251
	Redundant 'final' modifier.	1301
	Redundant 'final' modifier.	1331
	Redundant 'final' modifier.	1344
	Redundant 'final' modifier.	1379
	Redundant 'final' modifier.	1472

org/apache/maven/jxr/JxrException.java

Violation	Message	Line
	Missing a Javadoc comment.	31

org/apache/maven/jxr/ant/DirectoryScanner.java

Violation	Message	Line
	Missing a Javadoc comment.	33

org/apache/maven/jxr/log/Log.java

Violation	Message	Line
	Missing a Javadoc comment.	30
	Missing a Javadoc comment.	32
	Missing a Javadoc comment.	34
	Missing a Javadoc comment.	36

org/apache/maven/jxr/log/VelocityLogger.java

Violation	Message	Line
	Missing a Javadoc comment.	36
	Missing a Javadoc comment.	41

org/apache/maven/jxr/pacman/ClassType.java

Violation	Message	Line
	Expected @param tag for 'name'.	41
	Expected @param tag for 'name'.	52
	Expected @param tag for 'filename'.	52
	Missing a Javadoc comment.	59
	Missing a Javadoc comment.	64

org/apache/maven/jxr/pacman/FileManager.java

Violation	Message	Line
	Expected an @return tag.	51
	Expected an @return tag.	60
	Expected @param tag for 'name'.	60
	Expected @throws tag for 'IOException'.	61
	Expected @param tag for 'file'.	78
	Expected an @return tag.	98

org/apache/maven/jxr/pacman/ImportType.java

Violation	Message	Line
	Expected @param tag for 'name'.	40
	Expected an @return tag.	61
	Expected an @return tag.	69
	Expected an @return tag.	79

org/apache/maven/jxr/pacman/JavaFile.java

Violation	Message	Line
	Expected an @return tag.	48
	Expected an @return tag.	59
	Expected an @return tag.	75
	Expected an @return tag.	83
	Expected @param tag for 'classType'.	92
	Expected @param tag for 'importType'.	100
	Expected @param tag for 'classType'.	108
	Expected @param tag for 'packageType'.	118
	Expected an @return tag.	127
	Expected @param tag for 'filename'.	135
	Expected an @return tag.	144
	Expected @param tag for 'encoding'.	152

org/apache/maven/jxr/pacman/JavaFileImpl.java

Violation	Message	Line
	Expected @param tag for 'filename'.	50
	Expected @param tag for 'encoding'.	50
	Expected @throws tag for 'IOException'.	51

org/apache/maven/jxr/pacman/PackageManager.java

Violation	Message	Line
	Missing a Javadoc comment.	64
	Expected an @return tag.	74
	Expected @param tag for 'name'.	74
	Expected @param tag for 'packageType'.	89
	Expected an @return tag.	97
	Expected @param tag for 'directory'.	160
	'directories' hides a field.	172
	Expected @param tag for 'directories'.	172
	Missing a Javadoc comment.	214
	Missing a Javadoc comment.	219
	Missing a Javadoc comment.	225

org/apache/maven/jxr/pacman/PackageType.java

Violation	Message	Line
	Expected @param tag for 'name'.	39
	Expected an @return tag.	55
	Expected @param tag for 'classType'.	64
	Expected an @return tag.	75
	Expected @param tag for 'classType'.	75

org/apache/maven/jxr/util/SimpleWordTokenizer.java

Violation	Message	Line
	Expected an @return tag.	42
	Expected @param tag for 'line'.	42
	Expected an @return tag.	69
	Expression can be simplified.	197

org/apache/maven/jxr/util/StringEntry.java

Violation	Message	Line
	Expected @param tag for 'value'.	40
	Expected @param tag for 'index'.	40
	Expected an @return tag.	50
	Expected an @return tag.	58
	Expected an @return tag.	66
	Expected @param tag for 'obj'.	66
	Expression can be simplified.	70

Project Documentation

Maven Projects

ASF

Checkstyle Results

Summary

Files

Rules

Details

org/apache/maven/jxr/DirectoryIndexer.java

org/apache/maven/jxr/JXR.java

org/apache/maven/jxr/JavaCodeTransform.java

org/apache/maven/jxr/JxrException.java

org/apache/maven/jxr/ant/DirectoryScanner.java

org/apache/maven/jxr/log/Log.java

org/apache/maven/jxr/log/VelocityLogger.java

org/apache/maven/jxr/pacman/ClassType.java

org/apache/maven/jxr/pacman/FileManager.java

org/apache/maven/jxr/pacman/ImportType.java

org/apache/maven/jxr/pacman/JavaFile.java

org/apache/maven/jxr/pacman/JavaFileImpl.java

org/apache/maven/jxr/pacman/PackageManager.java

org/apache/maven/jxr/pacman/PackageType.java

org/apache/maven/jxr/util/SimpleWordTokenizer.java

org/apache/maven/jxr/util/StringEntry.java