Beyond the level of what Javadoc does, DoctorJ compares documentation against code. Among what it detects:

• misspelled words
• parameter and exception names:
• missing
• misordered
• misspelled
• Javadoc tags:
  • invalid
  • misordered
  • missing expected arguments
  • invalid arguments
  • missing descriptions
• undocumented classes, methods, fields, parameters

Note that previous versions supported syntax checking; we suggest PMD as an alternative application.

Changes in 5.1.2

Detection of run-time exceptions and errors has been improved, which reduces the number of reported @throws for exceptions not declared. Note that DoctorJ uses the current JVM (not source code) to determine which exceptions are run-time or errors, so users should set their classpath to include the class or jar files for the project being analyzed.

Changes in 5.1.1

By default, all errors and warnings are now reported. In previous versions, only errors were reported by default. The --warning option has been replaced with the --level option.

Changes in 5.1.0

DoctorJ has been rewritten (again), using the Java parser and AST from PMD. This adds support for Java 1.5. This version also includes improvements in performance and memory consumption.

Despite changes in the size of word lists in GNU/Linux distributions, DoctorJ still uses its own word list of 140,000 words.

Changes in 5.0.0

DoctorJ has been rewritten in Java. Errors and warnings have been simplified, so that there are now errors, and four levels of warnings, roughly arrayed by accessibility (public, protected, package, and private) of an item, such as a class, method, or field.