org.incava.doctorj
Class MethodDocAnalyzer
public class MethodDocAnalyzer
Analyzes Javadoc and code for methods.
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 |
protected void | addUndocumentedViolation(String desc) - Adds a violation for a method, with the violation pointing to the method
name.
|
protected void | checkJavadoc(JavadocNode javadoc)
|
protected net.sourceforge.pmd.ast.SimpleNode | getEnclosingNode() - Returns the parent node, which is the enclosing declaration.
|
String | getItemType() - Returns the type of item this analyzer is operating on.
|
protected net.sourceforge.pmd.ast.ASTFormalParameters | getParameterList() - Returns the parameter list for the method.
|
protected List | getValidTags() - Returns the valid tags, as strings, for methods.
|
MSG_RETURN_FOR_VOID_METHOD
public static final String MSG_RETURN_FOR_VOID_METHOD
MSG_RETURN_TYPE_USED
public static final String MSG_RETURN_TYPE_USED
MSG_RETURN_WITHOUT_DESCRIPTION
public static final String MSG_RETURN_WITHOUT_DESCRIPTION
MethodDocAnalyzer
public MethodDocAnalyzer(Report r,
net.sourceforge.pmd.ast.ASTMethodDeclaration method)
addUndocumentedViolation
protected void addUndocumentedViolation(String desc)
Adds a violation for a method, with the violation pointing to the method
name.
- addUndocumentedViolation in interface ItemDocAnalyzer
getEnclosingNode
protected net.sourceforge.pmd.ast.SimpleNode getEnclosingNode()
Returns the parent node, which is the enclosing declaration.
- getEnclosingNode in interface ItemDocAnalyzer
getItemType
public String getItemType()
Returns the type of item this analyzer is operating on.
- getItemType in interface ItemDocAnalyzer
getParameterList
protected net.sourceforge.pmd.ast.ASTFormalParameters getParameterList()
Returns the parameter list for the method.
- getParameterList in interface FunctionDocAnalyzer