org.incava.doctorj
public class MethodDocAnalyzer extends FunctionDocAnalyzer
Field Summary | |
---|---|
static String | MSG_RETURN_FOR_VOID_METHOD |
static String | MSG_RETURN_TYPE_USED |
static String | MSG_RETURN_WITHOUT_DESCRIPTION |
Constructor Summary | |
---|---|
MethodDocAnalyzer(Report r, ASTMethodDeclaration method) |
Method Summary | |
---|---|
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 SimpleNode | getEnclosingNode()
Returns the parent node, which is the enclosing declaration. |
String | getItemType() |
protected ASTFormalParameters | getParameterList()
Returns the parameter list for the method. |
protected List | getValidTags()
Returns the valid tags, as strings, for methods. |