Checkstyle Results

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

rss feed

Summary

Files
 Info
 Warnings
 Errors
10 0 50 1

Files

File
 I
 W
 E
org/apache/maven/search/Record.java 0 14 0
org/apache/maven/search/SearchBackend.java 0 2 0
org/apache/maven/search/SearchEngine.java 0 2 0
org/apache/maven/search/SearchRequest.java 0 6 1
org/apache/maven/search/SearchResponse.java 0 4 0
org/apache/maven/search/request/BooleanQuery.java 0 5 0
org/apache/maven/search/request/Field.java 0 4 0
org/apache/maven/search/request/FieldQuery.java 0 4 0
org/apache/maven/search/request/Paging.java 0 6 0
org/apache/maven/search/request/Query.java 0 3 0

Rules

Category Rule Violations Severity
coding MagicNumber
  • ignoreNumbers: "-4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 31, 32, 37, 64, 100, 128, 256, 512, 1000, 1024"
1
 Error
javadoc JavadocMethod
  • accessModifiers: "public, protected"
50
 Warning

Details

org/apache/maven/search/Record.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. 69
 Warning
javadoc JavadocMethod @return tag should be present and have description. 78
 Warning
javadoc JavadocMethod @return tag should be present and have description. 87
 Warning
javadoc JavadocMethod @return tag should be present and have description. 95
 Warning
javadoc JavadocMethod @return tag should be present and have description. 103
 Warning
javadoc JavadocMethod @return tag should be present and have description. 111
 Warning
javadoc JavadocMethod Expected @param tag for 'field'. 111
 Warning
javadoc JavadocMethod @return tag should be present and have description. 119
 Warning
javadoc JavadocMethod Expected @param tag for 'field'. 119
 Warning
javadoc JavadocMethod @return tag should be present and have description. 127
 Warning
javadoc JavadocMethod Expected @param tag for 'field'. 127
 Warning
javadoc JavadocMethod @return tag should be present and have description. 135
 Warning
javadoc JavadocMethod Expected @param tag for 'field'. 135

org/apache/maven/search/SearchBackend.java

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

org/apache/maven/search/SearchEngine.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod @return tag should be present and have description. 32
 Warning
javadoc JavadocMethod Expected @param tag for 'searchRequest'. 32

org/apache/maven/search/SearchRequest.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod Expected @param tag for 'query'. 39
 Error
coding MagicNumber '50' is a magic number. 41
 Warning
javadoc JavadocMethod Expected @param tag for 'paging'. 47
 Warning
javadoc JavadocMethod Expected @param tag for 'query'. 47
 Warning
javadoc JavadocMethod @return tag should be present and have description. 56
 Warning
javadoc JavadocMethod @return tag should be present and have description. 64
 Warning
javadoc JavadocMethod @return tag should be present and have description. 72

org/apache/maven/search/SearchResponse.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod @return tag should be present and have description. 32
 Warning
javadoc JavadocMethod @return tag should be present and have description. 37
 Warning
javadoc JavadocMethod @return tag should be present and have description. 43
 Warning
javadoc JavadocMethod @return tag should be present and have description. 48

org/apache/maven/search/request/BooleanQuery.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod @return tag should be present and have description. 43
 Warning
javadoc JavadocMethod @return tag should be present and have description. 51
 Warning
javadoc JavadocMethod @return tag should be present and have description. 74
 Warning
javadoc JavadocMethod Expected @param tag for 'left'. 74
 Warning
javadoc JavadocMethod Expected @param tag for 'rights'. 74

org/apache/maven/search/request/Field.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. 53
 Warning
javadoc JavadocMethod @return tag should be present and have description. 62
 Warning
javadoc JavadocMethod Expected @param tag for 'record'. 62

org/apache/maven/search/request/FieldQuery.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod @return tag should be present and have description. 44
 Warning
javadoc JavadocMethod @return tag should be present and have description. 58
 Warning
javadoc JavadocMethod Expected @param tag for 'fieldName'. 58
 Warning
javadoc JavadocMethod Expected @param tag for 'query'. 58

org/apache/maven/search/request/Paging.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod Expected @param tag for 'pageSize'. 34
 Warning
javadoc JavadocMethod Expected @param tag for 'pageOffset'. 34
 Warning
javadoc JavadocMethod Expected @param tag for 'pageSize'. 51
 Warning
javadoc JavadocMethod @return tag should be present and have description. 59
 Warning
javadoc JavadocMethod @return tag should be present and have description. 67
 Warning
javadoc JavadocMethod @return tag should be present and have description. 75

org/apache/maven/search/request/Query.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod @return tag should be present and have description. 39
 Warning
javadoc JavadocMethod @return tag should be present and have description. 53
 Warning
javadoc JavadocMethod Expected @param tag for 'queryString'. 53