org.incava.doctorj
public abstract class TypeDocAnalyzer extends ItemDocAnalyzer
Field Summary | |
---|---|
static String | MSG_AUTHOR_WITHOUT_NAME
The message for an author without a name. |
static String | MSG_SERIAL_WITHOUT_TEXT
The message for a serial field without a description. |
static String | MSG_VERSION_WITHOUT_TEXT
The message for a version without associated text. |
Constructor Summary | |
---|---|
TypeDocAnalyzer(Report r, ASTClassOrInterfaceDeclaration decl)
Creates an analyzer, but does not yet run. |
Method Summary | |
---|---|
protected void | addUndocumentedViolation(String desc)
Adds a violation, for something that is not documented. |
protected void | checkJavadoc(JavadocNode javadoc)
Checks the Javadoc against that expected by a type. |
protected SimpleNode | getEnclosingNode() |