org.incava.doctorj
Class TypeDocAnalyzer

java.lang.Object
  extended by org.incava.analysis.Analyzer
      extended by org.incava.doctorj.DocAnalyzer
          extended by org.incava.doctorj.ItemDocAnalyzer
              extended by org.incava.doctorj.TypeDocAnalyzer
Direct Known Subclasses:
ClassDocAnalyzer, InterfaceDocAnalyzer

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 java.lang.String MSG_AUTHOR_WITHOUT_NAME
          The message for an author without a name.
static java.lang.String MSG_SERIAL_WITHOUT_TEXT
          The message for a serial field without a description.
static java.lang.String MSG_VERSION_WITHOUT_TEXT
          The message for a version without associated text.
 
Fields inherited from class org.incava.doctorj.ItemDocAnalyzer
CHKLVL_MISORDERED_TAGS, CHKLVL_SUMMARY_SENTENCE, CHKLVL_VALID_TAGS, MSG_DEPRECATED_WITHOUT_TEXT, MSG_NO_SUMMARY_SENTENCE, MSG_SEE_WITHOUT_REFERENCE, MSG_SINCE_WITHOUT_TEXT, MSG_SUMMARY_SENTENCE_DOES_NOT_END_WITH_PERIOD, MSG_SUMMARY_SENTENCE_TOO_SHORT, MSG_TAG_IMPROPER_ORDER, spellChecker
 
Fields inherited from class org.incava.doctorj.DocAnalyzer
CHKLVL_DOC_EXISTS, CHKLVL_TAG_CONTENT
 
Constructor Summary
TypeDocAnalyzer(Report r, ASTClassOrInterfaceDeclaration decl)
          Creates an analyzer, but does not yet run.
 
Method Summary
protected  void addUndocumentedViolation(java.lang.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()
          Returns the node that contains the access and modifier tokens.
 
Methods inherited from class org.incava.doctorj.ItemDocAnalyzer
addDictionary, checkForTagDescription, getItemType, getJavadoc, getNode, getValidTags, run
 
Methods inherited from class org.incava.doctorj.DocAnalyzer
isCheckable
 
Methods inherited from class org.incava.analysis.Analyzer
addViolation, addViolation, addViolation, getReport
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MSG_AUTHOR_WITHOUT_NAME

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

See Also:
Constant Field Values

MSG_VERSION_WITHOUT_TEXT

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

See Also:
Constant Field Values

MSG_SERIAL_WITHOUT_TEXT

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

See Also:
Constant Field Values
Constructor Detail

TypeDocAnalyzer

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

Method Detail

checkJavadoc

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

Overrides:
checkJavadoc in class ItemDocAnalyzer

addUndocumentedViolation

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

Specified by:
addUndocumentedViolation in class ItemDocAnalyzer

getEnclosingNode

protected SimpleNode getEnclosingNode()
Description copied from class: ItemDocAnalyzer
Returns the node that contains the access and modifier tokens.

Specified by:
getEnclosingNode in class ItemDocAnalyzer