|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.incava.analysis.Analyzer
org.incava.doctorj.DocAnalyzer
org.incava.doctorj.ItemDocAnalyzer
org.incava.doctorj.FunctionDocAnalyzer
public abstract class FunctionDocAnalyzer
Analyzes Javadoc and code for methods and constructors, AKA functions.
Field Summary | |
---|---|
static java.lang.String |
MSG_SERIALDATA_WITHOUT_DESCRIPTION
|
Fields inherited from class org.incava.doctorj.DocAnalyzer |
---|
CHKLVL_DOC_EXISTS, CHKLVL_TAG_CONTENT |
Constructor Summary | |
---|---|
FunctionDocAnalyzer(Report r,
SimpleNode node)
|
Method Summary | |
---|---|
protected void |
checkJavadoc(JavadocNode javadoc)
|
protected abstract ASTFormalParameters |
getParameterList()
Returns the parameter list for the function. |
Methods inherited from class org.incava.doctorj.ItemDocAnalyzer |
---|
addDictionary, addUndocumentedViolation, checkForTagDescription, getEnclosingNode, getItemType, getJavadoc, getNode, getValidTags, run |
Methods inherited from class org.incava.doctorj.DocAnalyzer |
---|
isCheckable |
Methods inherited from class org.incava.analysis.Analyzer |
---|
addViolation, addViolation, addViolation, getReport |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String MSG_SERIALDATA_WITHOUT_DESCRIPTION
Constructor Detail |
---|
public FunctionDocAnalyzer(Report r, SimpleNode node)
Method Detail |
---|
protected void checkJavadoc(JavadocNode javadoc)
checkJavadoc
in class ItemDocAnalyzer
protected abstract ASTFormalParameters getParameterList()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |