Checkstyle Results

The following document contains the results of Checkstyle 13.3.0 with config/checkstyle/checkstyle.xml ruleset.

Summary

Files	Info	Warnings	Errors
6	0	0	32

Files

File	I	W	E
io/github/olyutorskii/ghmvnlibtmpl/Entry.java	0	0	5
io/github/olyutorskii/ghmvnlibtmpl/JavaDoc.java	0	0	10
io/github/olyutorskii/ghmvnlibtmpl/Lib.java	0	0	3
io/github/olyutorskii/ghmvnlibtmpl/Resource.java	0	0	13
io/github/olyutorskii/ghmvnlibtmpl/resources/test.properties	0	0	1

Rules

Category	Rule	Violations	Severity
coding	MissingCtor	2	Error
	RequireThis validateOnlyOverlapping: "false" checkMethods: "false"	1	Error
design	FinalClass	1	Error
	HideUtilityClassConstructor	1	Error
	VisibilityModifier	2	Error
indentation	CommentsIndentation	1	Error
javadoc	AtclauseOrder	1	Error
	JavadocBlockTagLocation	2	Error
	JavadocStyle endOfSentenceFormat: "([。.?!][ \t\n\r\f<])|([。.?!]$)" checkEmptyJavadoc: "true" checkHtml: "true"	1	Error
	JavadocVariable accessModifiers: "public, protected, package"	5	Error
	MissingJavadocMethod	2	Error
	MissingJavadocType	2	Error
	NonEmptyAtclauseDescription	3	Error
	RequireEmptyLineBeforeBlockTagGroup	2	Error
misc	OrderedProperties	1	Error
	UncommentedMain	1	Error
regexp	Regexp format: "^ \* License : The MIT License" duplicateLimit: "1"	1	Error
	Regexp format: "^ \* Copyright\(c\)"	1	Error
	Regexp format: "@author" illegalPattern: "true"	1	Error
whitespace	WhitespaceAround	2	Error

Details

io/github/olyutorskii/ghmvnlibtmpl/Entry.java

Severity	Category	Rule	Message	Line
Error	coding	MissingCtor	Class should define a constructor.	8
Error	design	HideUtilityClassConstructor	Utility classes should not have a public or default constructor.	8
Error	javadoc	MissingJavadocType	Missing a Javadoc comment.	8
Error	misc	UncommentedMain	Uncommented main method found.	10
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	10

io/github/olyutorskii/ghmvnlibtmpl/JavaDoc.java

Severity	Category	Rule	Message	Line
Error	javadoc	AtclauseOrder	Block tags have to appear in the order '[@author, @version, @param, @return, @throws, @exception, @see, @since, @serial, @serialField, @serialData, @deprecated]'.	20
Error	regexp	Regexp	Line matches the illegal pattern '@author'.	20
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	24
Error	design	VisibilityModifier	Variable 'field' must be private and have accessor methods.	24
Error	javadoc	JavadocBlockTagLocation	The Javadoc block tag '@param' should be placed at the beginning of the line.	90
Error	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	91
Error	javadoc	RequireEmptyLineBeforeBlockTagGroup	Javadoc tag '@param' should be preceded with an empty line.	91
Error	javadoc	JavadocBlockTagLocation	The Javadoc block tag '@param' should be placed at the beginning of the line.	100
Error	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	101
Error	javadoc	RequireEmptyLineBeforeBlockTagGroup	Javadoc tag '@param' should be preceded with an empty line.	101

io/github/olyutorskii/ghmvnlibtmpl/Lib.java

Severity	Category	Rule	Message	Line
Error	coding	MissingCtor	Class should define a constructor.	8
Error	javadoc	MissingJavadocType	Missing a Javadoc comment.	8
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	10

io/github/olyutorskii/ghmvnlibtmpl/Resource.java

Severity	Category	Rule	Message	Line
Error	design	FinalClass	Class Resource should be declared as final.	12
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	14
Error	indentation	CommentsIndentation	Comment has incorrect indentation level 12, expected is 4, indentation should be the same level as line 18.	16
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	18
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	19
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	21
Error	design	VisibilityModifier	Variable 'props' must be private and have accessor methods.	21
Error	javadoc	JavadocStyle	Javadoc has empty description section.	36
Error	javadoc	JavadocContentLocation	Javadoc content should start from the next line after /**.	36
Error	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	38
Error	coding	RequireThis	Reference to instance variable 'props' needs "this.".	48
Error	whitespace	WhitespaceAround	'{' is not preceded with whitespace.	53
Error	whitespace	WhitespaceAround	'{' is not preceded with whitespace.	66

io/github/olyutorskii/ghmvnlibtmpl/resources/test.properties

Severity	Category	Rule	Message	Line
Error	misc	OrderedProperties	Property key 'han' is not in the right order with previous property 'key'.	8