Checkstyle Results

The following document contains the results of Checkstyle 8.29 with org/sw4j/quality-profile/checkstyle/checkstyle-8.29.xml ruleset. 

Summary

Files	Info	Warnings	Errors
4	1	144	3

Files

File	I	W	E
org/sw4j/tool/html/crawler/ExternalReferenceEvent.java	0	4	0
org/sw4j/tool/html/crawler/LinkType.java	0	4	0
org/sw4j/tool/html/crawler/RelationType.java	0	19	0
org/sw4j/tool/html/crawler/SinglePageCrawler.java	1	117	3

Rules

Category	Rule	Violations	Severity
blocks	EmptyBlock	1	Error
design	FinalClass	2	Error
javadoc	JavadocMethod validateThrows: "true" allowedAnnotations: ""	22	Warning
	JavadocPackage	1	Warning
	JavadocParagraph	1	Info
	JavadocStyle checkEmptyJavadoc: "true"	21	Warning
	JavadocVariable	69	Warning
	NonEmptyAtclauseDescription	22	Warning
misc	FinalParameters	5	Warning
whitespace	SeparatorWrap tokens: "DOT,AT,RBRACK" option: "nl"	2	Warning
	SeparatorWrap tokens: "COMMA,SEMI,ELLIPSIS,LPAREN,RPAREN,ARRAY_DECLARATOR" option: "eol"	2	Warning
	WhitespaceAround	2	Warning

Details

org/sw4j/tool/html/crawler/ExternalReferenceEvent.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	23
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	25
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	27
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	29

org/sw4j/tool/html/crawler/LinkType.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	23
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	24
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	25
Warning	whitespace	SeparatorWrap	';' should be on the previous line.	26

org/sw4j/tool/html/crawler/RelationType.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	23
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	24
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	25
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	26
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	27
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	28
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	29
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	31
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	32
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	33
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	34
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	35
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	36
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	37
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	38
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	39
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	40
Warning	whitespace	SeparatorWrap	';' should be on the previous line.	41

org/sw4j/tool/html/crawler/SinglePageCrawler.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocPackage	Missing package-info.java file.	1
Error	design	FinalClass	Class SinglePageCrawler should be declared as final.	31
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	33
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	35
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	37
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	39
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	41
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	43
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	45
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	47
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	49
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	51
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	53
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	55
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	57
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	59
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	61
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	63
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	65
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	67
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	69
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	71
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	73
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	75
Warning	misc	FinalParameters	Parameter content should be final.	127
Warning	misc	FinalParameters	Parameter baseUri should be final.	127
Error	blocks	EmptyBlock	Must have at least one statement.	134
Warning	misc	FinalParameters	Parameter content should be final.	138
Warning	misc	FinalParameters	Parameter baseUri should be final.	138
Warning	misc	FinalParameters	Parameter link should be final.	144
Warning	javadoc	JavadocStyle	First sentence should end with a period.	175
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	178
Warning	javadoc	JavadocMethod	Expected @return tag.	181
Warning	javadoc	JavadocStyle	First sentence should end with a period.	183
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	186
Warning	javadoc	JavadocMethod	Expected @return tag.	189
Warning	javadoc	JavadocStyle	First sentence should end with a period.	191
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	194
Warning	javadoc	JavadocMethod	Expected @return tag.	197
Warning	javadoc	JavadocStyle	First sentence should end with a period.	199
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	202
Warning	javadoc	JavadocMethod	Expected @return tag.	205
Warning	javadoc	JavadocStyle	First sentence should end with a period.	207
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	210
Warning	javadoc	JavadocMethod	Expected @return tag.	213
Warning	javadoc	JavadocStyle	First sentence should end with a period.	215
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	218
Warning	javadoc	JavadocMethod	Expected @return tag.	221
Warning	javadoc	JavadocStyle	First sentence should end with a period.	223
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	226
Warning	javadoc	JavadocMethod	Expected @return tag.	229
Warning	javadoc	JavadocStyle	First sentence should end with a period.	231
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	234
Warning	javadoc	JavadocMethod	Expected @return tag.	237
Warning	javadoc	JavadocStyle	First sentence should end with a period.	239
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	242
Warning	javadoc	JavadocMethod	Expected @return tag.	245
Warning	javadoc	JavadocStyle	First sentence should end with a period.	247
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	250
Warning	javadoc	JavadocMethod	Expected @return tag.	253
Warning	javadoc	JavadocStyle	First sentence should end with a period.	255
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	258
Warning	javadoc	JavadocMethod	Expected @return tag.	261
Warning	javadoc	JavadocStyle	First sentence should end with a period.	263
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	267
Warning	javadoc	JavadocMethod	Expected @return tag.	270
Warning	javadoc	JavadocStyle	First sentence should end with a period.	272
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	275
Warning	javadoc	JavadocMethod	Expected @return tag.	278
Info	javadoc	JavadocParagraph	Empty line should be followed by <p> tag on the next line.	281
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	284
Warning	javadoc	JavadocMethod	Expected @return tag.	287
Warning	javadoc	JavadocStyle	First sentence should end with a period.	289
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	292
Warning	javadoc	JavadocMethod	Expected @return tag.	295
Warning	javadoc	JavadocStyle	First sentence should end with a period.	297
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	300
Warning	javadoc	JavadocMethod	Expected @return tag.	303
Warning	javadoc	JavadocStyle	First sentence should end with a period.	305
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	308
Warning	javadoc	JavadocMethod	Expected @return tag.	311
Warning	javadoc	JavadocStyle	First sentence should end with a period.	313
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	316
Warning	javadoc	JavadocMethod	Expected @return tag.	319
Warning	javadoc	JavadocStyle	First sentence should end with a period.	321
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	324
Warning	javadoc	JavadocMethod	Expected @return tag.	327
Warning	javadoc	JavadocStyle	First sentence should end with a period.	329
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	332
Warning	javadoc	JavadocMethod	Expected @return tag.	335
Warning	javadoc	JavadocStyle	First sentence should end with a period.	337
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	340
Warning	javadoc	JavadocMethod	Expected @return tag.	343
Warning	javadoc	JavadocStyle	First sentence should end with a period.	345
Warning	javadoc	NonEmptyAtclauseDescription	At-clause should have a non-empty description.	348
Warning	javadoc	JavadocMethod	Expected @return tag.	351
Error	design	FinalClass	Class BuilderImpl should be declared as final.	358
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	360
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	362
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	364
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	366
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	368
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	370
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	372
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	374
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	376
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	378
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	380
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	382
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	384
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	386
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	388
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	390
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	392
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	394
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	396
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	398
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	400
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	402
Warning	whitespace	WhitespaceAround	'{' is not followed by whitespace.	404
Warning	whitespace	WhitespaceAround	'}' is not preceded with whitespace.	404