public abstract class TypeDocAnalyzer extends ItemDocAnalyzer
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
MSG_AUTHOR_WITHOUT_NAME
The message for an author without a name.
|
static java.lang.String |
MSG_SERIAL_WITHOUT_TEXT
The message for a serial field without a description.
|
static java.lang.String |
MSG_VERSION_WITHOUT_TEXT
The message for a version without associated 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 |
---|
TypeDocAnalyzer(Report r,
ASTClassOrInterfaceDeclaration decl)
Creates an analyzer, but does not yet run.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addUndocumentedViolation(java.lang.String desc)
Adds a violation, for something that is not documented.
|
protected void |
checkJavadoc(JavadocNode javadoc)
Checks the Javadoc against that expected by a type.
|
protected SimpleNode |
getEnclosingNode()
Returns the node that contains the access and modifier tokens.
|
addDictionary, checkForTagDescription, getItemType, getJavadoc, getNode, getValidTags, run
isCheckable
addViolation, addViolation, addViolation, getReport
public static final java.lang.String MSG_AUTHOR_WITHOUT_NAME
public static final java.lang.String MSG_VERSION_WITHOUT_TEXT
public static final java.lang.String MSG_SERIAL_WITHOUT_TEXT
public TypeDocAnalyzer(Report r, ASTClassOrInterfaceDeclaration decl)
protected void checkJavadoc(JavadocNode javadoc)
checkJavadoc
in class ItemDocAnalyzer
protected void addUndocumentedViolation(java.lang.String desc)
addUndocumentedViolation
in class ItemDocAnalyzer
protected SimpleNode getEnclosingNode()
ItemDocAnalyzer
getEnclosingNode
in class ItemDocAnalyzer