org.incava.doctorj

Class FieldDocAnalyzer


public class FieldDocAnalyzer
extends ItemDocAnalyzer

Analyzes Javadoc and code for fields.

Field Summary

static String
MSG_SERIALFIELD_WITHOUT_DESCRIPTION
static String
MSG_SERIALFIELD_WITHOUT_NAME_TYPE_AND_DESCRIPTION
static 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, net.sourceforge.pmd.ast.ASTFieldDeclaration field)

Method Summary

protected void
addUndocumentedViolation(String desc)
Adds a violation for a field, with the violation pointing to the field name.
protected void
checkJavadoc(JavadocNode javadoc)
protected net.sourceforge.pmd.ast.SimpleNode
getEnclosingNode()
Returns the node that contains the access and modifier tokens.
String
getItemType()
Returns the type of item this analyzer is operating on.
protected List
getValidTags()
Returns the valid tags, as strings, for fields.

Methods inherited from class org.incava.doctorj.ItemDocAnalyzer

addDictionary, addUndocumentedViolation, checkForTagDescription, checkJavadoc, getEnclosingNode, 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, addViolation, getReport

Field Details

MSG_SERIALFIELD_WITHOUT_DESCRIPTION

public static final String MSG_SERIALFIELD_WITHOUT_DESCRIPTION

MSG_SERIALFIELD_WITHOUT_NAME_TYPE_AND_DESCRIPTION

public static final String MSG_SERIALFIELD_WITHOUT_NAME_TYPE_AND_DESCRIPTION

MSG_SERIALFIELD_WITHOUT_TYPE_AND_DESCRIPTION

public static final String MSG_SERIALFIELD_WITHOUT_TYPE_AND_DESCRIPTION

Constructor Details

FieldDocAnalyzer

public FieldDocAnalyzer(Report r,
                        net.sourceforge.pmd.ast.ASTFieldDeclaration field)

Method Details

addUndocumentedViolation

protected void addUndocumentedViolation(String desc)
Adds a violation for a field, with the violation pointing to the field name.
Overrides:
addUndocumentedViolation in interface ItemDocAnalyzer

checkJavadoc

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

getEnclosingNode

protected net.sourceforge.pmd.ast.SimpleNode getEnclosingNode()
Returns the node that contains the access and modifier tokens.
Overrides:
getEnclosingNode in interface ItemDocAnalyzer

getItemType

public String getItemType()
Returns the type of item this analyzer is operating on.
Overrides:
getItemType in interface ItemDocAnalyzer

getValidTags

protected List getValidTags()
Returns the valid tags, as strings, for fields.
Overrides:
getValidTags in interface ItemDocAnalyzer