SPECTRa - Checkstyle Results

Checkstyle Results

The following document contains the results of Checkstyle.

Files	Infos	Warnings	Errors
8	0	0	59

Files	I	W	E
spok/GenerateId.java	0	0	7
spok/JcampToCMLSpectrumMapper.java	0	0	12
spok/package.html	0	0	1
uk/ac/cam/spectra/nmr/JCampDX.java	0	0	14
uk/ac/cam/spectra/nmr/JCampDXErrorHandler.java	0	0	4
uk/ac/cam/spectra/nmr/MDLMol.java	0	0	15
uk/ac/cam/spectra/nmr/NMRMetadata.java	0	0	5
uk/ac/cam/spectra/nmr/package.html	0	0	1

Rules	Violations	Severity
PackageHtml	2	Error
JavadocType	1	Error
JavadocMethod allowThrowsTagsForSubclasses: `"true"` allowUndeclaredRTE: `"false"` scope: `"package"` allowMissingPropertyJavadoc: `"true"`	22	Error
JavadocVariable scope: `"package"`	7	Error
JavadocStyle checkEmptyJavadoc: `"true"`	12	Error
PackageName format: `"^uk\.ac\.cam\..*$"`	2	Error
AvoidStarImport	0	Error
RedundantImport	0	Error
UnusedImports	0	Error
ParameterNumber	0	Error
NeedBraces	1	Error
CovariantEquals	0	Error
DoubleCheckedLocking	0	Error
EqualsHashCode	0	Error
HiddenField ignoreConstructorParameter: `"true"` ignoreSetter: `"true"`	0	Error
IllegalInstantiation classes: `"java.lang.Boolean"`	0	Error
InnerAssignment	0	Error
MagicNumber ignoreNumbers: `"0, -1, 1"`	6	Error
StringLiteralEquality	1	Error
PackageDeclaration	0	Error
MultipleStringLiterals allowedDuplicates: `"2"`	4	Error
HideUtilityClassConstructor	1	Error

Violation	Message	Line
	Name 'spok' must match pattern '^uk\.ac\.cam\..*$'.	1
	First sentence should end with a period.	7
	Utility classes should not have a public or default constructor.	13
	First sentence should end with a period.	16
	'0xf0' is a magic number.	63
	'4' is a magic number.	63
	'0x0f' is a magic number.	64

Violation	Message	Line
	Name 'spok' must match pattern '^uk\.ac\.cam\..*$'.	1
	First sentence should end with a period.	58
	First sentence should end with a period.	116
	The String "jcampdx:" appears 5 times in the file.	130
	First sentence should end with a period.	137
	First sentence should end with a period.	171
	Literal Strings should be compared using equals(), not '!='.	222
	The String "//entry[@id='" appears 4 times in the file.	242
	Expected an @return tag.	322
	Expected @param tag for 'key'.	322
	'2' is a magic number.	324
	'if' construct must use '{}'s.	332

Violation	Message	Line
	Missing package documentation file.	0

Violation	Message	Line
	Javadoc has empty description section.	48
	'20' is a magic number.	58
	Missing a Javadoc comment.	65
	Javadoc has empty description section.	74
	Expected an @return tag.	77
	Expected @param tag for 'process'.	77
	First sentence should end with a period.	106
	Javadoc has empty description section.	132
	Expected an @return tag.	135
	Expected @param tag for 'jcampFile'.	136
	Expected @param tag for 'packageUri'.	136
	'2' is a magic number.	146
	Missing a Javadoc comment.	172
	Expected @param tag for 'process'.	184

Violation	Message	Line
	Javadoc has empty description section.	31
	Javadoc has empty description section.	43
	Expected an @return tag.	46
	Expected @param tag for 'file'.	46
	The String "Problem reading from " appears 6 times in the file.	55
	The String ": " appears 6 times in the file.	55
	Expected an @return tag.	76
	Expected @param tag for 'file'.	76
	Expected @param tag for 'packageUri'.	76
	Missing a Javadoc comment.	80
	Missing a Javadoc comment.	109
	Missing a Javadoc comment.	118
	Missing a Javadoc comment.	132
	Missing a Javadoc comment.	133
	Missing a Javadoc comment.	135

Violation	Message	Line
	Missing package documentation file.	0