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
12 0 91 0

Files

File
 I
 W
 E
org/apache/maven/jxr/DirectoryIndexer.java 0 20 0
org/apache/maven/jxr/JXR.java 0 20 0
org/apache/maven/jxr/JxrException.java 0 1 0
org/apache/maven/jxr/pacman/ClassType.java 0 5 0
org/apache/maven/jxr/pacman/FileManager.java 0 5 0
org/apache/maven/jxr/pacman/ImportType.java 0 4 0
org/apache/maven/jxr/pacman/JavaFile.java 0 14 0
org/apache/maven/jxr/pacman/JavaFileImpl.java 0 3 0
org/apache/maven/jxr/pacman/PackageManager.java 0 8 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"
 91
 Warning

Details

org/apache/maven/jxr/DirectoryIndexer.java

Severity Category Rule Message Line
 Warning		 javadoc JavadocMethod Expected an @return tag. 118
 Warning		 javadoc JavadocMethod Expected an @return tag. 137
 Warning		 javadoc JavadocMethod Expected an @return tag. 158
 Warning		 javadoc JavadocMethod Expected an @return tag. 179
 Warning		 javadoc JavadocMethod Expected an @return tag. 200
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 383
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 389
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 394
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 415
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 421
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 426
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 431
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 436
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 441
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 446
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 466
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 473
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 478
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 483
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 488

org/apache/maven/jxr/JXR.java

Severity Category Rule Message Line
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 87
 Warning		 javadoc JavadocMethod Expected @param tag for 'packageManager'. 101
 Warning		 javadoc JavadocMethod Expected @param tag for 'sourceDir'. 101
 Warning		 javadoc JavadocMethod Expected @param tag for 'bottom'. 101
 Warning		 javadoc JavadocMethod Expected @throws tag for 'IOException'. 102
 Warning		 javadoc JavadocMethod Expected @param tag for 'dest'. 156
 Warning		 javadoc JavadocMethod Expected @param tag for 'locale'. 164
 Warning		 javadoc JavadocMethod Expected @param tag for 'inputEncoding'. 172
 Warning		 javadoc JavadocMethod Expected @param tag for 'outputEncoding'. 180
 Warning		 javadoc JavadocMethod Expected @param tag for 'javadocLinkDir'. 188
 Warning		 javadoc JavadocMethod Expected @param tag for 'revision'. 197
 Warning		 javadoc JavadocMethod Expected @param tag for 'sourceDirs'. 211
 Warning		 javadoc JavadocMethod Expected @param tag for 'templateDir'. 211
 Warning		 javadoc JavadocMethod Expected @param tag for 'windowTitle'. 211
 Warning		 javadoc JavadocMethod Expected @param tag for 'docTitle'. 211
 Warning		 javadoc JavadocMethod Expected @param tag for 'bottom'. 211
 Warning		 javadoc JavadocMethod Expected @throws tag for 'IOException'. 212
 Warning		 javadoc JavadocMethod Expected @throws tag for 'JxrException'. 212
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 278
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 284

org/apache/maven/jxr/JxrException.java

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

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. 48
 Warning		 javadoc JavadocMethod Expected @param tag for 'path'. 48
 Warning		 javadoc JavadocMethod Expected @throws tag for 'IOException'. 49
 Warning		 javadoc JavadocMethod Expected @param tag for 'file'. 66
 Warning		 javadoc JavadocMethod Expected an @return tag. 86

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. 49
 Warning		 javadoc JavadocMethod Expected an @return tag. 59
 Warning		 javadoc JavadocMethod Expected an @return tag. 67
 Warning		 javadoc JavadocMethod Expected an @return tag. 83
 Warning		 javadoc JavadocMethod Expected an @return tag. 91
 Warning		 javadoc JavadocMethod Expected @param tag for 'classType'. 100
 Warning		 javadoc JavadocMethod Expected @param tag for 'importType'. 108
 Warning		 javadoc JavadocMethod Expected @param tag for 'classType'. 116
 Warning		 javadoc JavadocMethod Expected @param tag for 'packageType'. 126
 Warning		 javadoc JavadocMethod Expected an @return tag. 135
 Warning		 javadoc JavadocMethod Expected an @return tag. 143
 Warning		 javadoc JavadocMethod Expected an @return tag. 151
 Warning		 javadoc JavadocMethod Expected an @return tag. 159
 Warning		 javadoc JavadocMethod Expected @param tag for 'path'. 159

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. 67
 Warning		 javadoc JavadocMethod Expected an @return tag. 76
 Warning		 javadoc JavadocMethod Expected @param tag for 'name'. 76
 Warning		 javadoc JavadocMethod Expected @param tag for 'packageType'. 91
 Warning		 javadoc JavadocMethod Expected an @return tag. 99
 Warning		 javadoc JavadocMethod Expected @param tag for 'directory'. 160
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 188
 Warning		 javadoc JavadocMethod Missing a Javadoc comment. 194

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

Severity Category Rule Message Line
 Warning		 javadoc JavadocMethod Expected @param tag for 'name'. 40
 Warning		 javadoc JavadocMethod Expected an @return tag. 56
 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'. 38
 Warning		 javadoc JavadocMethod Expected @param tag for 'index'. 38
 Warning		 javadoc JavadocMethod Expected an @return tag. 48