org.incava.doctorj
public class ExceptionDocAnalyzer extends DocAnalyzer
Field Summary | |
---|---|
protected static int | CHKLVL_EXCEPTIONS_ALPHABETICAL |
protected static int | CHKLVL_EXCEPTION_DOC_EXISTS |
protected static String[] | KNOWN_RUNTIME_EXCEPTIONS |
static String | MSG_EXCEPTIONS_NOT_ALPHABETICAL |
static String | MSG_EXCEPTION_MISSPELLED |
static String | MSG_EXCEPTION_NOT_DOCUMENTED |
static String | MSG_EXCEPTION_NOT_IN_THROWS_LIST |
static String | MSG_EXCEPTION_WITHOUT_CLASS_NAME |
static String | MSG_EXCEPTION_WITHOUT_DESCRIPTION |
Constructor Summary | |
---|---|
ExceptionDocAnalyzer(Report report, JavadocNode javadoc, SimpleNode function, int nodeLevel)
Creates and runs the exception documentation analyzer.
|
Method Summary | |
---|---|
protected void | checkAgainstCode(JavadocTag tag, JavadocElement tgt, String shortExcName, String fullExcName, Class excClass) |
protected ASTName | getClosestMatchingException(String str)
Returns the name in the list that most closely matches the given string. |
protected String | getExactMatch(String name) |
protected ASTName | getMatchingException(String str)
Returns the first name in the list that matches the given string. |
protected String | getShortName(String name)
Returns the short name of the class, e.g., Integer instead of
java.lang.Integer. |
protected boolean | isRuntimeException(Class excClass)
Returns whether the given class is derived from Runtimeexception or
Error. |
protected Class | loadClass(String clsName) |
protected Map | makeImportMap(ASTImportDeclaration[] imports) |
protected void | reportUndocumentedExceptions() |
void | run() |
Parameters: report The report to which to send violations. javadoc The javadoc for the function. Should not be null. function The constructor or method.