Checkstyle Results

The following document contains the results of Checkstyle 6.8.2 with https://git.sw4j.net/sw4j-org/quality-profile/raw/master/src/main/resources/org/sw4j/quality-profile/checkstyle/checkstyle-6.19.xml ruleset. 

Summary

Files	Info	Warnings	Errors
17	9	75	0

Files

File	I	W	E
org/sw4j/apisniffer/ApiScanner.java	3	6	0
org/sw4j/apisniffer/api/AnnotationType.java	0	1	0
org/sw4j/apisniffer/api/ApiElement.java	0	2	0
org/sw4j/apisniffer/api/ClassType.java	0	1	0
org/sw4j/apisniffer/api/EnumType.java	0	2	0
org/sw4j/apisniffer/api/InterfaceType.java	0	1	0
org/sw4j/apisniffer/builder/AnnotationTypeBuilder.java	1	2	0
org/sw4j/apisniffer/builder/ApiBuilder.java	2	4	0
org/sw4j/apisniffer/builder/ClassTypeBuilder.java	1	1	0
org/sw4j/apisniffer/builder/EnumTypeBuilder.java	1	1	0
org/sw4j/apisniffer/builder/InterfaceTypeBuilder.java	1	1	0
org/sw4j/apisniffer/builder/TypeBuilder.java	0	5	0
org/sw4j/apisniffer/util/ApiUtils.java	0	3	0
org/sw4j/apisniffer/visitor/ApiClassVisitor.java	0	45	0

Rules

Category	Rule	Violations	Severity
coding	MissingCtor	8	Info
indentation	Indentation throwsIndent: "0" arrayInitIndent: "4" forceStrictCondition: "false" caseIndent: "4" basicOffset: "4" braceAdjustment: "0" lineWrappingIndentation: "4"	1	Info
javadoc	JavadocMethod validateThrows: "true" allowUndeclaredRTE: "true" logLoadErrors: "false" allowThrowsTagsForSubclasses: "true" allowedAnnotations: ""	21	Warning
	JavadocPackage	5	Warning
	JavadocStyle checkEmptyJavadoc: "true"	12	Warning
	JavadocVariable	4	Warning
	NonEmptyAtclauseDescription	1	Warning
misc	FinalParameters	32	Warning

Details

org/sw4j/apisniffer/ApiScanner.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocPackage	Missing package-info.java file.
Warning	javadoc	JavadocStyle	Javadoc has empty description section.	31
Info	coding	MissingCtor	Class should define a constructor.	35
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	38
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	40
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	62
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	68
Info	coding	MissingCtor	Class should define a constructor.	86
Info	indentation	Indentation	'implements' have incorrect indentation level 4, expected level should be 8.	87

org/sw4j/apisniffer/api/AnnotationType.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocStyle	Javadoc has empty description section.	19

org/sw4j/apisniffer/api/ApiElement.java

Severity	Category	Rule	Message	Line
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	29
Warning	javadoc	JavadocMethod	Expected an @return tag.	31

org/sw4j/apisniffer/api/ClassType.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocStyle	Javadoc has empty description section.	19

org/sw4j/apisniffer/api/EnumType.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocPackage	Missing package-info.java file.
Warning	javadoc	JavadocStyle	Javadoc has empty description section.	19

org/sw4j/apisniffer/api/InterfaceType.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocStyle	Javadoc has empty description section.	19

org/sw4j/apisniffer/builder/AnnotationTypeBuilder.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocPackage	Missing package-info.java file.
Warning	javadoc	JavadocStyle	Javadoc has empty description section.	19
Info	coding	MissingCtor	Class should define a constructor.	23

org/sw4j/apisniffer/builder/ApiBuilder.java

Severity	Category	Rule	Message	Line
Info	coding	MissingCtor	Class should define a constructor.	30
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	33
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	37
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	41
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	45
Info	coding	MissingCtor	Class should define a constructor.	62

org/sw4j/apisniffer/builder/ClassTypeBuilder.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocStyle	Javadoc has empty description section.	19
Info	coding	MissingCtor	Class should define a constructor.	23

org/sw4j/apisniffer/builder/EnumTypeBuilder.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocStyle	Javadoc has empty description section.	19
Info	coding	MissingCtor	Class should define a constructor.	23

org/sw4j/apisniffer/builder/InterfaceTypeBuilder.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocStyle	Javadoc has empty description section.	19
Info	coding	MissingCtor	Class should define a constructor.	23

org/sw4j/apisniffer/builder/TypeBuilder.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocStyle	Javadoc has empty description section.	19
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	25
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	27
Warning	misc	FinalParameters	Parameter name should be final.	27
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	31

org/sw4j/apisniffer/util/ApiUtils.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocPackage	Missing package-info.java file.
Warning	javadoc	JavadocStyle	Javadoc has empty description section.	19
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	25

org/sw4j/apisniffer/visitor/ApiClassVisitor.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocPackage	Missing package-info.java file.
Warning	javadoc	JavadocStyle	Javadoc has empty description section.	30
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	37
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	39
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	41
Warning	misc	FinalParameters	Parameter apiBuilder should be final.	41
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	46
Warning	misc	FinalParameters	Parameter version should be final.	47
Warning	misc	FinalParameters	Parameter access should be final.	47
Warning	misc	FinalParameters	Parameter name should be final.	47
Warning	misc	FinalParameters	Parameter signature should be final.	47
Warning	misc	FinalParameters	Parameter superName should be final.	47
Warning	misc	FinalParameters	Parameter interfaces should be final.	48
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	62
Warning	misc	FinalParameters	Parameter access should be final.	63
Warning	misc	FinalParameters	Parameter name should be final.	63
Warning	misc	FinalParameters	Parameter desc should be final.	63
Warning	misc	FinalParameters	Parameter signature should be final.	63
Warning	misc	FinalParameters	Parameter exceptions should be final.	64
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	68
Warning	misc	FinalParameters	Parameter access should be final.	69
Warning	misc	FinalParameters	Parameter name should be final.	69
Warning	misc	FinalParameters	Parameter desc should be final.	69
Warning	misc	FinalParameters	Parameter signature should be final.	69
Warning	misc	FinalParameters	Parameter value should be final.	70
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	74
Warning	misc	FinalParameters	Parameter name should be final.	75
Warning	misc	FinalParameters	Parameter outerName should be final.	75
Warning	misc	FinalParameters	Parameter innerName should be final.	75
Warning	misc	FinalParameters	Parameter access should be final.	75
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	79
Warning	misc	FinalParameters	Parameter attr should be final.	80
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	84
Warning	misc	FinalParameters	Parameter typeRef should be final.	85
Warning	misc	FinalParameters	Parameter typePath should be final.	85
Warning	misc	FinalParameters	Parameter desc should be final.	85
Warning	misc	FinalParameters	Parameter visible should be final.	86
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	90
Warning	misc	FinalParameters	Parameter desc should be final.	91
Warning	misc	FinalParameters	Parameter visible should be final.	91
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	95
Warning	misc	FinalParameters	Parameter owner should be final.	96
Warning	misc	FinalParameters	Parameter name should be final.	96
Warning	misc	FinalParameters	Parameter desc should be final.	96
Warning	javadoc	JavadocMethod	Missing a Javadoc comment.	100