public class MethodDocAnalyzer extends FunctionDocAnalyzer
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
MSG_RETURN_FOR_VOID_METHOD |
static java.lang.String |
MSG_RETURN_TYPE_USED |
static java.lang.String |
MSG_RETURN_WITHOUT_DESCRIPTION |
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 |
---|
MethodDocAnalyzer(Report r,
ASTMethodDeclaration method) |
Modifier and Type | Method and Description |
---|---|
protected void |
addUndocumentedViolation(java.lang.String desc)
Adds a violation for a method, with the violation pointing to the method
name.
|
protected void |
checkJavadoc(JavadocNode javadoc) |
protected SimpleNode |
getEnclosingNode()
Returns the parent node, which is the enclosing declaration.
|
java.lang.String |
getItemType()
Returns the type of item this analyzer is operating on.
|
protected ASTFormalParameters |
getParameterList()
Returns the parameter list for the method.
|
protected java.util.List |
getValidTags()
Returns the valid tags, as strings, for methods.
|
addDictionary, checkForTagDescription, getJavadoc, getNode, run
isCheckable
addViolation, addViolation, addViolation, getReport
public static final java.lang.String MSG_RETURN_WITHOUT_DESCRIPTION
public static final java.lang.String MSG_RETURN_FOR_VOID_METHOD
public static final java.lang.String MSG_RETURN_TYPE_USED
public MethodDocAnalyzer(Report r, ASTMethodDeclaration method)
public java.lang.String getItemType()
ItemDocAnalyzer
getItemType
in class ItemDocAnalyzer
protected SimpleNode getEnclosingNode()
getEnclosingNode
in class ItemDocAnalyzer
protected void checkJavadoc(JavadocNode javadoc)
checkJavadoc
in class FunctionDocAnalyzer
protected ASTFormalParameters getParameterList()
getParameterList
in class FunctionDocAnalyzer
protected java.util.List getValidTags()
getValidTags
in class ItemDocAnalyzer
protected void addUndocumentedViolation(java.lang.String desc)
addUndocumentedViolation
in class ItemDocAnalyzer