Checkstyle Results

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

Summary

Files	Info	Warnings	Errors
11	0	55	1

Files

File	I	W	E
org/apache/maven/search/api/Record.java	0	14	0
org/apache/maven/search/api/SearchBackend.java	0	2	0
org/apache/maven/search/api/SearchEngine.java	0	2	0
org/apache/maven/search/api/SearchRequest.java	0	6	1
org/apache/maven/search/api/SearchResponse.java	0	4	0
org/apache/maven/search/api/request/BooleanQuery.java	0	5	0
org/apache/maven/search/api/request/Field.java	0	3	0
org/apache/maven/search/api/request/FieldQuery.java	0	4	0
org/apache/maven/search/api/request/Paging.java	0	6	0
org/apache/maven/search/api/request/Query.java	0	3	0
org/apache/maven/search/api/transport/Transport.java	0	6	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"	55	Warning

Details

org/apache/maven/search/api/Record.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	54
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.	77
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	84
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	91
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	98
Warning	javadoc	JavadocMethod	Expected @param tag for 'field'.	98
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	105
Warning	javadoc	JavadocMethod	Expected @param tag for 'field'.	105
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	112
Warning	javadoc	JavadocMethod	Expected @param tag for 'field'.	112
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	119
Warning	javadoc	JavadocMethod	Expected @param tag for 'field'.	119

org/apache/maven/search/api/SearchBackend.java

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

org/apache/maven/search/api/SearchEngine.java

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

org/apache/maven/search/api/SearchRequest.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Expected @param tag for 'query'.	37
Error	coding	MagicNumber	'50' is a magic number.	38
Warning	javadoc	JavadocMethod	Expected @param tag for 'paging'.	44
Warning	javadoc	JavadocMethod	Expected @param tag for 'query'.	44
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	52
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	59
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	66

org/apache/maven/search/api/SearchResponse.java

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

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

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

org/apache/maven/search/api/request/Field.java

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

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

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

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

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	Expected @param tag for 'pageSize'.	32
Warning	javadoc	JavadocMethod	Expected @param tag for 'pageOffset'.	32
Warning	javadoc	JavadocMethod	Expected @param tag for 'pageSize'.	46
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	53
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	60
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	67

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

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

org/apache/maven/search/api/transport/Transport.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	47
Warning	javadoc	JavadocMethod	Expected @param tag for 'serviceUri'.	47
Warning	javadoc	JavadocMethod	Expected @param tag for 'headers'.	47
Warning	javadoc	JavadocMethod	@return tag should be present and have description.	52
Warning	javadoc	JavadocMethod	Expected @param tag for 'serviceUri'.	52
Warning	javadoc	JavadocMethod	Expected @param tag for 'headers'.	52