org.incava.doctorj
Class FieldDocAnalyzer

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.FieldDocAnalyzer

public class FieldDocAnalyzer
extends ItemDocAnalyzer

Analyzes Javadoc and code for fields.


Field Summary
static java.lang.String MSG_SERIALFIELD_WITHOUT_DESCRIPTION
           
static java.lang.String MSG_SERIALFIELD_WITHOUT_NAME_TYPE_AND_DESCRIPTION
           
static java.lang.String MSG_SERIALFIELD_WITHOUT_TYPE_AND_DESCRIPTION
           
 
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
FieldDocAnalyzer(Report r, ASTFieldDeclaration field)
           
 
Method Summary
protected  void addUndocumentedViolation(java.lang.String desc)
          Adds a violation for a field, with the violation pointing to the field name.
protected  void checkJavadoc(JavadocNode javadoc)
           
protected  SimpleNode getEnclosingNode()
          Returns the node that contains the access and modifier tokens.
 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 fields.
 
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
 

Field Detail

MSG_SERIALFIELD_WITHOUT_NAME_TYPE_AND_DESCRIPTION

public static final java.lang.String MSG_SERIALFIELD_WITHOUT_NAME_TYPE_AND_DESCRIPTION
See Also:
Constant Field Values

MSG_SERIALFIELD_WITHOUT_TYPE_AND_DESCRIPTION

public static final java.lang.String MSG_SERIALFIELD_WITHOUT_TYPE_AND_DESCRIPTION
See Also:
Constant Field Values

MSG_SERIALFIELD_WITHOUT_DESCRIPTION

public static final java.lang.String MSG_SERIALFIELD_WITHOUT_DESCRIPTION
See Also:
Constant Field Values
Constructor Detail

FieldDocAnalyzer

public FieldDocAnalyzer(Report r,
                        ASTFieldDeclaration field)
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

checkJavadoc

protected void checkJavadoc(JavadocNode javadoc)
Overrides:
checkJavadoc in class ItemDocAnalyzer

getValidTags

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

Specified by:
getValidTags in class ItemDocAnalyzer

addUndocumentedViolation

protected void addUndocumentedViolation(java.lang.String desc)
Adds a violation for a field, with the violation pointing to the field name.

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