Package org.incava.doctorj

Class Summary

ClassDocAnalyzer Analyzes Javadoc and code for a class, either concrete or abstract.
CommentSpellCheck
CtorDocAnalyzer Analyzes Javadoc and code for constructors.
DocAnalyzer Analyzes Javadoc and code.
DoctorJ
ExceptionDocAnalyzer Checks for violations of rules applying to exceptions.
FieldDocAnalyzer Analyzes Javadoc and code for fields.
FunctionDocAnalyzer Analyzes Javadoc and code for methods and constructors, AKA functions.
InterfaceDocAnalyzer Analyzes Javadoc and code for an interface.
ItemCommentSpellCheck
ItemDocAnalyzer Analyzes Javadoc and code.
JavadocAnalyzer Analyzes Javadoc and code.
JavadocTags Javadoc tags and the order in which they should appear for each Java type.
JavadocTags.TagDescription
MethodDocAnalyzer Analyzes Javadoc and code for methods.
Options Options for Javadoc processing, supporting: doctorj (just errors) doctorj --public (warning level of 0; public methods) doctorj --protected (warning level of 1) doctorj --package (warning level of 2) doctorj --private (warning level of 3) doctorj --pedantic (warning level at max)
ParameterDocAnalyzer Checks the validity of Javadoc for a list of parameters.
TypeDocAnalyzer Analyzes Javadoc and code for a type, which is a class (concrete or abstract) or an interface.