Checkstyle Results

The following document contains the results of Checkstyle 9.3 with config/maven_checks_nocodestyle.xml ruleset.

Summary

Files  Info  Warnings  Errors
8 7 55 0

Files

File  I  W  E
org/apache/maven/index/reader/ChunkReader.java 0 3 0
org/apache/maven/index/reader/ChunkWriter.java 0 5 0
org/apache/maven/index/reader/IndexReader.java 0 5 0
org/apache/maven/index/reader/IndexWriter.java 0 7 0
org/apache/maven/index/reader/Record.java 0 15 0
org/apache/maven/index/reader/ResourceHandler.java 0 2 0
org/apache/maven/index/reader/Utils.java 7 16 0
org/apache/maven/index/reader/WritableResourceHandler.java 0 2 0

Rules

Category Rule Violations Severity
coding HiddenField
  • ignoreConstructorParameter: "true"
  • setterCanReturnItsClass: "true"
  • ignoreSetter: "true"
1  Warning
javadoc JavadocMethod
  • accessModifiers: "public, protected"
54  Warning
JavadocVariable
  • scope: "protected"
7  Info

Details

org/apache/maven/index/reader/ChunkReader.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod @return tag should be present and have description. 61
 Warning javadoc JavadocMethod @return tag should be present and have description. 68
 Warning javadoc JavadocMethod @return tag should be present and have description. 75

org/apache/maven/index/reader/ChunkWriter.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod @return tag should be present and have description. 67
 Warning javadoc JavadocMethod @return tag should be present and have description. 74
 Warning javadoc JavadocMethod @return tag should be present and have description. 81
 Warning javadoc JavadocMethod @return tag should be present and have description. 88
 Warning javadoc JavadocMethod Expected @param tag for 'iterator'. 88

org/apache/maven/index/reader/IndexReader.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod @return tag should be present and have description. 112
 Warning javadoc JavadocMethod @return tag should be present and have description. 119
 Warning javadoc JavadocMethod @return tag should be present and have description. 127
 Warning javadoc JavadocMethod @return tag should be present and have description. 136
 Warning coding HiddenField 'chunkNames' hides a field. 184

org/apache/maven/index/reader/IndexWriter.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod @return tag should be present and have description. 95
 Warning javadoc JavadocMethod @return tag should be present and have description. 104
 Warning javadoc JavadocMethod @return tag should be present and have description. 119
 Warning javadoc JavadocMethod @return tag should be present and have description. 127
 Warning javadoc JavadocMethod @return tag should be present and have description. 134
 Warning javadoc JavadocMethod @return tag should be present and have description. 141
 Warning javadoc JavadocMethod Expected @param tag for 'iterator'. 141

org/apache/maven/index/reader/Record.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod @return tag should be present and have description. 366
 Warning javadoc JavadocMethod @return tag should be present and have description. 373
 Warning javadoc JavadocMethod @return tag should be present and have description. 387
 Warning javadoc JavadocMethod Expected @param tag for 'entryKey'. 387
 Warning javadoc JavadocMethod @return tag should be present and have description. 396
 Warning javadoc JavadocMethod Expected @param tag for 'entryKey'. 396
 Warning javadoc JavadocMethod @return tag should be present and have description. 409
 Warning javadoc JavadocMethod Expected @param tag for 'entryKey'. 409
 Warning javadoc JavadocMethod @return tag should be present and have description. 422
 Warning javadoc JavadocMethod Expected @param tag for 'entryKey'. 422
 Warning javadoc JavadocMethod @return tag should be present and have description. 434
 Warning javadoc JavadocMethod Expected @param tag for 'entryKey'. 434
 Warning javadoc JavadocMethod @return tag should be present and have description. 445
 Warning javadoc JavadocMethod Expected @param tag for 'entryKey'. 445
 Warning javadoc JavadocMethod Expected @param tag for 'value'. 445

org/apache/maven/index/reader/ResourceHandler.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod @return tag should be present and have description. 41
 Warning javadoc JavadocMethod @return tag should be present and have description. 57

org/apache/maven/index/reader/Utils.java

Severity Category Rule Message Line
 Info javadoc JavadocVariable Missing a Javadoc comment. 47
 Info javadoc JavadocVariable Missing a Javadoc comment. 49
 Info javadoc JavadocVariable Missing a Javadoc comment. 56
 Info javadoc JavadocVariable Missing a Javadoc comment. 58
 Info javadoc JavadocVariable Missing a Javadoc comment. 60
 Info javadoc JavadocVariable Missing a Javadoc comment. 62
 Info javadoc JavadocVariable Missing a Javadoc comment. 64
 Warning javadoc JavadocMethod @return tag should be present and have description. 70
 Warning javadoc JavadocMethod Expected @param tag for 'resource'. 70
 Warning javadoc JavadocMethod Expected @param tag for 'writableResource'. 84
 Warning javadoc JavadocMethod Expected @param tag for 'properties'. 84
 Warning javadoc JavadocMethod @return tag should be present and have description. 96
 Warning javadoc JavadocMethod Expected @param tag for 'repoId'. 96
 Warning javadoc JavadocMethod @return tag should be present and have description. 105
 Warning javadoc JavadocMethod Expected @param tag for 'allGroups'. 105
 Warning javadoc JavadocMethod @return tag should be present and have description. 114
 Warning javadoc JavadocMethod Expected @param tag for 'rootGroups'. 114
 Warning javadoc JavadocMethod @return tag should be present and have description. 123
 Warning javadoc JavadocMethod Expected @param tag for 'v'. 123
 Warning javadoc JavadocMethod @return tag should be present and have description. 130
 Warning javadoc JavadocMethod Expected @param tag for 'v'. 130
 Warning javadoc JavadocMethod @return tag should be present and have description. 137
 Warning javadoc JavadocMethod Expected @param tag for 'groupId'. 137

org/apache/maven/index/reader/WritableResourceHandler.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod @return tag should be present and have description. 45
 Warning javadoc JavadocMethod @return tag should be present and have description. 54