org.incava.doctorj
Class ClassDocAnalyzer

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
                  extended by org.incava.doctorj.ClassDocAnalyzer

public class ClassDocAnalyzer
extends TypeDocAnalyzer

Analyzes Javadoc and code for a class, either concrete or abstract.


Field Summary
 
Fields inherited from class org.incava.doctorj.TypeDocAnalyzer
MSG_AUTHOR_WITHOUT_NAME, MSG_SERIAL_WITHOUT_TEXT, MSG_VERSION_WITHOUT_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
ClassDocAnalyzer(Report r, ASTClassOrInterfaceDeclaration node)
           
 
Method Summary
 java.lang.String getItemType()
          Returns the type of item this analyzer is operating on.
protected  java.util.List getValidTags()
          Returns the valid tags, as strings, for classes.
 
Methods inherited from class org.incava.doctorj.TypeDocAnalyzer
addUndocumentedViolation, checkJavadoc, getEnclosingNode
 
Methods inherited from class org.incava.doctorj.ItemDocAnalyzer
addDictionary, checkForTagDescription, getJavadoc, getNode, 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
 

Constructor Detail

ClassDocAnalyzer

public ClassDocAnalyzer(Report r,
                        ASTClassOrInterfaceDeclaration node)
Method Detail

getItemType

public java.lang.String getItemType()
Description copied from class: ItemDocAnalyzer
Returns the type of item this analyzer is operating on.

Specified by:
getItemType in class ItemDocAnalyzer

getValidTags

protected java.util.List getValidTags()
Returns the valid tags, as strings, for classes.

Specified by:
getValidTags in class ItemDocAnalyzer