public class InterfaceDocAnalyzer extends TypeDocAnalyzer
MSG_AUTHOR_WITHOUT_NAME, MSG_SERIAL_WITHOUT_TEXT, MSG_VERSION_WITHOUT_TEXT
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 |
---|
InterfaceDocAnalyzer(Report r,
ASTClassOrInterfaceDeclaration node) |
Modifier and Type | Method and Description |
---|---|
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 interfaces.
|
addUndocumentedViolation, checkJavadoc, getEnclosingNode
addDictionary, checkForTagDescription, getJavadoc, getNode, run
isCheckable
addViolation, addViolation, addViolation, getReport
public InterfaceDocAnalyzer(Report r, ASTClassOrInterfaceDeclaration node)
public java.lang.String getItemType()
ItemDocAnalyzer
getItemType
in class ItemDocAnalyzer
protected java.util.List getValidTags()
getValidTags
in class ItemDocAnalyzer