| Class Summary | |
|---|---|
| Analyzer | Bridge between violations and reports. |
| ANSI | |
| ANSIColor | Provides constants that produce colorized output on ANSI terminals. |
| ASTDumper | |
| BooleanOption | Represents an option that is an boolean. |
| ClassDocAnalyzer | Analyzes Javadoc and code for a class, either concrete or abstract. |
| ClassUtil | Miscellaneous routines for classs. |
| Collect | Collects a collections into a collection. |
| CommentSpellCheck | |
| CompilationUnitUtil | Miscellaneous routines for compilation units. |
| ContextReport | Reports errors in multiple lines, displaying the contextual code, and denoting the code to which a violation applies. |
| CtorDocAnalyzer | Analyzes Javadoc and code for constructors. |
| CtorUtil | Miscellaneous routines for constructors. |
| DocAnalyzer | Analyzes Javadoc and code. |
| DoctorJ | |
| DoubleOption | Represents an option that is an double. |
| ExceptionDocAnalyzer | Checks for violations of rules applying to exceptions. |
| FieldDocAnalyzer | Analyzes Javadoc and code for fields. |
| FieldUtil | Miscellaneous routines for fields. |
| FileExt | |
| Find |
Support for find(1)-like behavior. |
| FloatOption | Represents an option that is an float. |
| FunctionDocAnalyzer | Analyzes Javadoc and code for methods and constructors, AKA functions. |
| FunctionUtil | Miscellaneous routines for functions (ctors and methods). |
| IntegerOption | Represents an option that is an integer. |
| InterfaceDocAnalyzer | Analyzes Javadoc and code for an interface. |
| InterfaceUtil | Miscellaneous routines for interfaces. |
| InvalidTypeException | |
| ItemCommentSpellCheck | |
| ItemDocAnalyzer | Analyzes Javadoc and code. |
| ItemUtil | Miscellaneous routines for Items. |
| JavadocAnalyzer | Analyzes Javadoc and code. |
| JavadocDescriptionNode | The description section of a Javadoc comment. |
| JavadocElement | A field within a Javadoc comment. |
| JavadocNode | Represents a Javadoc element. |
| JavadocParser | Parses Javadoc into a list of points, which represent the locations of description and tagged comments in a Javadoc comment block. |
| JavadocTag | A Javadoc tag. |
| JavadocTaggedNode | A tagged element, such as: |
| JavadocTags | Javadoc tags and the order in which they should appear for each Java type. |
| JavadocTags.TagCollect | |
| JavadocTags.TagDescription | |
| LineMapping | Converts from 0-indexed string positions to line:column values. |
| LineMapping.PositionToLocation | |
| ListOption | Represents a list of objects that comprise this option. |
| Location | Code location. |
| MatchCriteria | A criterion (some criteria) for matching nodes. |
| MethodDocAnalyzer | Analyzes Javadoc and code for methods. |
| MethodMatchCriteria | A criterion (some criteria) for matching nodes. |
| MethodUtil | Miscellaneous routines for method declarations. |
| NoCaseSpellChecker | Calculates the edit distance between two strings. |
| NonBooleanOption | Base class of all options, except for booleans. |
| Option | Base class of all options. |
| OptionException | |
| 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) |
| OptionSet | A group of options. |
| ParameterDocAnalyzer | Checks the validity of Javadoc for a list of parameters. |
| ParameterUtil | Miscellaneous routines for parameters. |
| QlClassFilter | A filter for logging statements from a class. |
| QlCollection | Wraps Collections for output. |
| QlEnumeration | Wraps Enumerations for output. |
| QlFilter | Represents a filter for selective enabling or disabling of logging statements. |
| QlIterator | Wraps Iterators for output. |
| QlLevel |
Represents a logging/output level. |
| QlMap | Wraps Java maps for output. |
| QlObjectArray | Wraps C-style arrays for output. |
| QlTimedPeriod | |
| QlTimer | |
| QlWriter |
Writes the logging output, applying filters and decorations. |
| Qualog |
Provides quasi-logging support, more akin to debugging/development output and trace statements than logging per se. |
| Range | |
| Report | Reports errors (violations), in a format that is determined by the subclass. |
| ReverseComparator | A comparator for reversed order. |
| SimpleNodeUtil | Miscellaneous routines for the SimpleNode. |
| SpellChecker | Calculates the edit distance between two strings. |
| StringExt | Extensions to the String class. |
| StringOption | Represents an option that is an String. |
| TerseReport | Reports errors in a single line, AKA the format expected by Emacs (! |
| ThrowsUtil | Miscellaneous routines for throws lists. |
| TimedEvent |
Times an event, from when the object is created, until when the
end method is invoked. |
| TimedEventSet | A set of timed events. |
| TypeDeclarationUtil | Miscellaneous routines for type declarations. |
| TypeDocAnalyzer | Analyzes Javadoc and code for a type, which is a class (concrete or abstract) or an interface. |
| ValueExpectedException | |
| VariableUtil | Miscellaneous routines for variables (declarators). |
| Violation | An error or a warning, associated with a file by a starting and ending position, and a message. |