public abstract class FunctionDocAnalyzer extends ItemDocAnalyzer
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
MSG_SERIALDATA_WITHOUT_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 |
---|
FunctionDocAnalyzer(Report r,
SimpleNode node) |
Modifier and Type | Method and Description |
---|---|
protected void |
checkJavadoc(JavadocNode javadoc) |
protected abstract ASTFormalParameters |
getParameterList()
Returns the parameter list for the function.
|
addDictionary, addUndocumentedViolation, checkForTagDescription, getEnclosingNode, getItemType, getJavadoc, getNode, getValidTags, run
isCheckable
addViolation, addViolation, addViolation, getReport
public static final java.lang.String MSG_SERIALDATA_WITHOUT_DESCRIPTION
public FunctionDocAnalyzer(Report r, SimpleNode node)
protected void checkJavadoc(JavadocNode javadoc)
checkJavadoc
in class ItemDocAnalyzer
protected abstract ASTFormalParameters getParameterList()