Checkstyle Results

The following document contains the results of Checkstyle 5.7. rss feed

Summary

Files  Info  Warnings  Errors
16 0 92 0

Files

File  I  W  E
org/apache/maven/jxr/DirectoryIndexer.java 0 6 0
org/apache/maven/jxr/JXR.java 0 23 0
org/apache/maven/jxr/JxrException.java 0 1 0
org/apache/maven/jxr/ant/DirectoryScanner.java 0 1 0
org/apache/maven/jxr/log/Log.java 0 4 0
org/apache/maven/jxr/log/VelocityLogger.java 0 2 0
org/apache/maven/jxr/pacman/ClassType.java 0 5 0
org/apache/maven/jxr/pacman/FileManager.java 0 6 0
org/apache/maven/jxr/pacman/ImportType.java 0 4 0
org/apache/maven/jxr/pacman/JavaFile.java 0 12 0
org/apache/maven/jxr/pacman/JavaFileImpl.java 0 3 0
org/apache/maven/jxr/pacman/PackageManager.java 0 11 0
org/apache/maven/jxr/pacman/PackageType.java 0 5 0
org/apache/maven/jxr/util/SimpleWordTokenizer.java 0 3 0
org/apache/maven/jxr/util/StringEntry.java 0 6 0

Rules

Category Rule Violations Severity
coding HiddenField
  • ignoreConstructorParameter: "true"
  • ignoreSetter: "true"
 3  Warning
javadoc JavadocMethod
  • scope: "protected"
 89  Warning

Details

org/apache/maven/jxr/DirectoryIndexer.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected an @return tag. 121
 Warning javadoc JavadocMethod Expected an @return tag. 140
 Warning javadoc JavadocMethod Expected an @return tag. 161
 Warning javadoc JavadocMethod Expected an @return tag. 182
 Warning javadoc JavadocMethod Expected an @return tag. 203
 Warning javadoc JavadocMethod Expected @param tag for 'log'. 213

org/apache/maven/jxr/JXR.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected @param tag for 'packageManager'. 97
 Warning javadoc JavadocMethod Expected @param tag for 'source'. 97
 Warning javadoc JavadocMethod Expected @param tag for 'bottom'. 97
 Warning javadoc JavadocMethod Expected @throws tag for 'IOException'. 98
 Warning javadoc JavadocMethod Expected @param tag for 'dest'. 175
 Warning javadoc JavadocMethod Expected @param tag for 'locale'. 183
 Warning javadoc JavadocMethod Expected @param tag for 'inputEncoding'. 191
 Warning javadoc JavadocMethod Expected @param tag for 'outputEncoding'. 199
 Warning javadoc JavadocMethod Expected @param tag for 'javadocLinkDir'. 207
 Warning javadoc JavadocMethod Expected @param tag for 'transformer'. 216
 Warning javadoc JavadocMethod Expected @param tag for 'revision'. 224
 Warning javadoc JavadocMethod Expected @param tag for 'log'. 232
 Warning javadoc JavadocMethod Expected @param tag for 'sourceDirs'. 246
 Warning javadoc JavadocMethod Expected @param tag for 'templateDir'. 246
 Warning javadoc JavadocMethod Expected @param tag for 'windowTitle'. 246
 Warning javadoc JavadocMethod Expected @param tag for 'docTitle'. 246
 Warning javadoc JavadocMethod Expected @param tag for 'bottom'. 246
 Warning javadoc JavadocMethod Expected @throws tag for 'IOException'. 247
 Warning javadoc JavadocMethod Expected @throws tag for 'JxrException'. 247
 Warning coding HiddenField 'dest' hides a field. 293
 Warning coding HiddenField 'dest' hides a field. 323
 Warning javadoc JavadocMethod Missing a Javadoc comment. 404
 Warning javadoc JavadocMethod Missing a Javadoc comment. 410

org/apache/maven/jxr/JxrException.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Missing a Javadoc comment. 31

org/apache/maven/jxr/ant/DirectoryScanner.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Missing a Javadoc comment. 33

org/apache/maven/jxr/log/Log.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Missing a Javadoc comment. 30
 Warning javadoc JavadocMethod Missing a Javadoc comment. 32
 Warning javadoc JavadocMethod Missing a Javadoc comment. 34
 Warning javadoc JavadocMethod Missing a Javadoc comment. 36

org/apache/maven/jxr/log/VelocityLogger.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Missing a Javadoc comment. 36
 Warning javadoc JavadocMethod Missing a Javadoc comment. 41

org/apache/maven/jxr/pacman/ClassType.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected @param tag for 'name'. 41
 Warning javadoc JavadocMethod Expected @param tag for 'name'. 52
 Warning javadoc JavadocMethod Expected @param tag for 'filename'. 52
 Warning javadoc JavadocMethod Missing a Javadoc comment. 59
 Warning javadoc JavadocMethod Missing a Javadoc comment. 64

org/apache/maven/jxr/pacman/FileManager.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected an @return tag. 51
 Warning javadoc JavadocMethod Expected an @return tag. 60
 Warning javadoc JavadocMethod Expected @param tag for 'name'. 60
 Warning javadoc JavadocMethod Expected @throws tag for 'IOException'. 61
 Warning javadoc JavadocMethod Expected @param tag for 'file'. 78
 Warning javadoc JavadocMethod Expected an @return tag. 98

org/apache/maven/jxr/pacman/ImportType.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected @param tag for 'name'. 40
 Warning javadoc JavadocMethod Expected an @return tag. 61
 Warning javadoc JavadocMethod Expected an @return tag. 69
 Warning javadoc JavadocMethod Expected an @return tag. 79

org/apache/maven/jxr/pacman/JavaFile.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected an @return tag. 48
 Warning javadoc JavadocMethod Expected an @return tag. 59
 Warning javadoc JavadocMethod Expected an @return tag. 75
 Warning javadoc JavadocMethod Expected an @return tag. 83
 Warning javadoc JavadocMethod Expected @param tag for 'classType'. 92
 Warning javadoc JavadocMethod Expected @param tag for 'importType'. 100
 Warning javadoc JavadocMethod Expected @param tag for 'classType'. 108
 Warning javadoc JavadocMethod Expected @param tag for 'packageType'. 118
 Warning javadoc JavadocMethod Expected an @return tag. 127
 Warning javadoc JavadocMethod Expected @param tag for 'filename'. 135
 Warning javadoc JavadocMethod Expected an @return tag. 144
 Warning javadoc JavadocMethod Expected @param tag for 'encoding'. 152

org/apache/maven/jxr/pacman/JavaFileImpl.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected @param tag for 'filename'. 50
 Warning javadoc JavadocMethod Expected @param tag for 'encoding'. 50
 Warning javadoc JavadocMethod Expected @throws tag for 'IOException'. 51

org/apache/maven/jxr/pacman/PackageManager.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Missing a Javadoc comment. 62
 Warning javadoc JavadocMethod Expected an @return tag. 72
 Warning javadoc JavadocMethod Expected @param tag for 'name'. 72
 Warning javadoc JavadocMethod Expected @param tag for 'packageType'. 87
 Warning javadoc JavadocMethod Expected an @return tag. 95
 Warning javadoc JavadocMethod Expected @param tag for 'directory'. 157
 Warning coding HiddenField 'directories' hides a field. 169
 Warning javadoc JavadocMethod Expected @param tag for 'directories'. 169
 Warning javadoc JavadocMethod Missing a Javadoc comment. 211
 Warning javadoc JavadocMethod Missing a Javadoc comment. 216
 Warning javadoc JavadocMethod Missing a Javadoc comment. 222

org/apache/maven/jxr/pacman/PackageType.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected @param tag for 'name'. 39
 Warning javadoc JavadocMethod Expected an @return tag. 55
 Warning javadoc JavadocMethod Expected @param tag for 'classType'. 64
 Warning javadoc JavadocMethod Expected an @return tag. 75
 Warning javadoc JavadocMethod Expected @param tag for 'classType'. 75

org/apache/maven/jxr/util/SimpleWordTokenizer.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected an @return tag. 41
 Warning javadoc JavadocMethod Expected @param tag for 'line'. 41
 Warning javadoc JavadocMethod Expected an @return tag. 66

org/apache/maven/jxr/util/StringEntry.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected @param tag for 'value'. 40
 Warning javadoc JavadocMethod Expected @param tag for 'index'. 40
 Warning javadoc JavadocMethod Expected an @return tag. 50
 Warning javadoc JavadocMethod Expected an @return tag. 58
 Warning javadoc JavadocMethod Expected an @return tag. 66
 Warning javadoc JavadocMethod Expected @param tag for 'se'. 66