public class FieldDocAnalyzer extends ItemDocAnalyzer
Modifier and Type | Field and Description |
---|---|
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 |
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
CHKLVL_DOC_EXISTS, CHKLVL_TAG_CONTENT
Constructor and Description |
---|
FieldDocAnalyzer(Report r,
ASTFieldDeclaration field) |
Modifier and Type | Method and Description |
---|---|
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.
|
addDictionary, checkForTagDescription, getJavadoc, getNode, run
isCheckable
addViolation, addViolation, addViolation, getReport
public static final java.lang.String MSG_SERIALFIELD_WITHOUT_NAME_TYPE_AND_DESCRIPTION
public static final java.lang.String MSG_SERIALFIELD_WITHOUT_TYPE_AND_DESCRIPTION
public static final java.lang.String MSG_SERIALFIELD_WITHOUT_DESCRIPTION
public FieldDocAnalyzer(Report r, ASTFieldDeclaration field)
public java.lang.String getItemType()
ItemDocAnalyzer
getItemType
in class ItemDocAnalyzer
protected void checkJavadoc(JavadocNode javadoc)
checkJavadoc
in class ItemDocAnalyzer
protected java.util.List getValidTags()
getValidTags
in class ItemDocAnalyzer
protected void addUndocumentedViolation(java.lang.String desc)
addUndocumentedViolation
in class ItemDocAnalyzer
protected SimpleNode getEnclosingNode()
ItemDocAnalyzer
getEnclosingNode
in class ItemDocAnalyzer