Built by Maven

Checkstyle Results

The following document contains the results of Checkstyle 6.18 with config/maven_checks.xml ruleset. rss feed

Summary

Files  Info  Warnings  Errors
13 0 81 0

Files

File  I  W  E
org/apache/maven/jxr/DirectoryIndexer.java 0 6 0
org/apache/maven/jxr/JXR.java 0 21 0
org/apache/maven/jxr/JxrException.java 0 1 0
org/apache/maven/jxr/log/Log.java 0 4 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 11 0
org/apache/maven/jxr/pacman/JavaFileImpl.java 0 3 0
org/apache/maven/jxr/pacman/PackageManager.java 0 9 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 3 0

Rules

Category Rule Violations Severity
javadoc JavadocMethod
  • scope: "protected"
 81  Warning

Details

org/apache/maven/jxr/DirectoryIndexer.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected an @return tag. 123
 Warning javadoc JavadocMethod Expected an @return tag. 142
 Warning javadoc JavadocMethod Expected an @return tag. 163
 Warning javadoc JavadocMethod Expected an @return tag. 184
 Warning javadoc JavadocMethod Expected an @return tag. 205
 Warning javadoc JavadocMethod Expected @param tag for 'log'. 215

org/apache/maven/jxr/JXR.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected @param tag for 'packageManager'. 96
 Warning javadoc JavadocMethod Expected @param tag for 'sourceDir'. 96
 Warning javadoc JavadocMethod Expected @param tag for 'bottom'. 96
 Warning javadoc JavadocMethod Expected @throws tag for 'IOException'. 97
 Warning javadoc JavadocMethod Expected @param tag for 'dest'. 153
 Warning javadoc JavadocMethod Expected @param tag for 'locale'. 161
 Warning javadoc JavadocMethod Expected @param tag for 'inputEncoding'. 169
 Warning javadoc JavadocMethod Expected @param tag for 'outputEncoding'. 177
 Warning javadoc JavadocMethod Expected @param tag for 'javadocLinkDir'. 185
 Warning javadoc JavadocMethod Expected @param tag for 'transformer'. 194
 Warning javadoc JavadocMethod Expected @param tag for 'revision'. 202
 Warning javadoc JavadocMethod Expected @param tag for 'log'. 210
 Warning javadoc JavadocMethod Expected @param tag for 'sourceDirs'. 224
 Warning javadoc JavadocMethod Expected @param tag for 'templateDir'. 224
 Warning javadoc JavadocMethod Expected @param tag for 'windowTitle'. 224
 Warning javadoc JavadocMethod Expected @param tag for 'docTitle'. 224
 Warning javadoc JavadocMethod Expected @param tag for 'bottom'. 224
 Warning javadoc JavadocMethod Expected @throws tag for 'IOException'. 225
 Warning javadoc JavadocMethod Expected @throws tag for 'JxrException'. 225
 Warning javadoc JavadocMethod Missing a Javadoc comment. 296
 Warning javadoc JavadocMethod Missing a Javadoc comment. 302

org/apache/maven/jxr/JxrException.java

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

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/pacman/ClassType.java

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected @param tag for 'name'. 42
 Warning javadoc JavadocMethod Expected @param tag for 'name'. 53
 Warning javadoc JavadocMethod Expected @param tag for 'filename'. 53
 Warning javadoc JavadocMethod Missing a Javadoc comment. 60
 Warning javadoc JavadocMethod Missing a Javadoc comment. 65

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

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected an @return tag. 52
 Warning javadoc JavadocMethod Expected an @return tag. 61
 Warning javadoc JavadocMethod Expected @param tag for 'path'. 61
 Warning javadoc JavadocMethod Expected @throws tag for 'IOException'. 62
 Warning javadoc JavadocMethod Expected @param tag for 'file'. 79
 Warning javadoc JavadocMethod Expected an @return tag. 99

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 Missing a Javadoc comment. 47
 Warning javadoc JavadocMethod Expected an @return tag. 56
 Warning javadoc JavadocMethod Expected an @return tag. 64
 Warning javadoc JavadocMethod Expected an @return tag. 80
 Warning javadoc JavadocMethod Expected an @return tag. 88
 Warning javadoc JavadocMethod Expected @param tag for 'classType'. 97
 Warning javadoc JavadocMethod Expected @param tag for 'importType'. 105
 Warning javadoc JavadocMethod Expected @param tag for 'classType'. 113
 Warning javadoc JavadocMethod Expected @param tag for 'packageType'. 123
 Warning javadoc JavadocMethod Expected an @return tag. 132
 Warning javadoc JavadocMethod Expected an @return tag. 140

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

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Expected @param tag for 'path'. 48
 Warning javadoc JavadocMethod Expected @param tag for 'encoding'. 48
 Warning javadoc JavadocMethod Expected @throws tag for 'IOException'. 49

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

Severity Category Rule Message Line
 Warning javadoc JavadocMethod Missing a Javadoc comment. 65
 Warning javadoc JavadocMethod Expected an @return tag. 75
 Warning javadoc JavadocMethod Expected @param tag for 'name'. 75
 Warning javadoc JavadocMethod Expected @param tag for 'packageType'. 90
 Warning javadoc JavadocMethod Expected an @return tag. 98
 Warning javadoc JavadocMethod Expected @param tag for 'directory'. 160
 Warning javadoc JavadocMethod Missing a Javadoc comment. 200
 Warning javadoc JavadocMethod Missing a Javadoc comment. 205
 Warning javadoc JavadocMethod Missing a Javadoc comment. 211

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. 46
 Warning javadoc JavadocMethod Expected @param tag for 'line'. 46
 Warning javadoc JavadocMethod Expected an @return tag. 71

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