org.incava.doctorj

Class TypeDocAnalyzer

public abstract class TypeDocAnalyzer extends ItemDocAnalyzer

Analyzes Javadoc and code for a type, which is a class (concrete or abstract) or an interface.
Field Summary
static StringMSG_AUTHOR_WITHOUT_NAME
The message for an author without a name.
static StringMSG_SERIAL_WITHOUT_TEXT
The message for a serial field without a description.
static StringMSG_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 voidaddUndocumentedViolation(String desc)
Adds a violation, for something that is not documented.
protected voidcheckJavadoc(JavadocNode javadoc)
Checks the Javadoc against that expected by a type.
protected SimpleNodegetEnclosingNode()

Field Detail

MSG_AUTHOR_WITHOUT_NAME

public static final String MSG_AUTHOR_WITHOUT_NAME
The message for an author without a name.

MSG_SERIAL_WITHOUT_TEXT

public static final String MSG_SERIAL_WITHOUT_TEXT
The message for a serial field without a description.

MSG_VERSION_WITHOUT_TEXT

public static final String MSG_VERSION_WITHOUT_TEXT
The message for a version without associated text.

Constructor Detail

TypeDocAnalyzer

public TypeDocAnalyzer(Report r, ASTClassOrInterfaceDeclaration decl)
Creates an analyzer, but does not yet run.

Method Detail

addUndocumentedViolation

protected void addUndocumentedViolation(String desc)
Adds a violation, for something that is not documented.

checkJavadoc

protected void checkJavadoc(JavadocNode javadoc)
Checks the Javadoc against that expected by a type.

getEnclosingNode

protected SimpleNode getEnclosingNode()