org.incava.doctorj

Class FunctionDocAnalyzer

public abstract class FunctionDocAnalyzer extends ItemDocAnalyzer

Analyzes Javadoc and code for methods and constructors, AKA functions.
Field Summary
static StringMSG_SERIALDATA_WITHOUT_DESCRIPTION
Constructor Summary
FunctionDocAnalyzer(Report r, SimpleNode node)
Method Summary
protected voidcheckJavadoc(JavadocNode javadoc)
protected abstract ASTFormalParametersgetParameterList()
Returns the parameter list for the function.

Field Detail

MSG_SERIALDATA_WITHOUT_DESCRIPTION

public static final String MSG_SERIALDATA_WITHOUT_DESCRIPTION

Constructor Detail

FunctionDocAnalyzer

public FunctionDocAnalyzer(Report r, SimpleNode node)

Method Detail

checkJavadoc

protected void checkJavadoc(JavadocNode javadoc)

getParameterList

protected abstract ASTFormalParameters getParameterList()
Returns the parameter list for the function.