org.incava.doctorj

Class FunctionDocAnalyzer

Known Direct Subclasses:
CtorDocAnalyzer, MethodDocAnalyzer

public abstract class FunctionDocAnalyzer
extends ItemDocAnalyzer

Analyzes Javadoc and code for methods and constructors, AKA functions.

Field Summary

static String
MSG_SERIALDATA_WITHOUT_DESCRIPTION

Fields inherited from class org.incava.doctorj.ItemDocAnalyzer

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

Fields inherited from class org.incava.doctorj.DocAnalyzer

CHKLVL_DOC_EXISTS, CHKLVL_TAG_CONTENT

Constructor Summary

FunctionDocAnalyzer(Report r, net.sourceforge.pmd.ast.SimpleNode node)

Method Summary

protected void
checkJavadoc(JavadocNode javadoc)
protected abstract net.sourceforge.pmd.ast.ASTFormalParameters
getParameterList()
Returns the parameter list for the function.

Methods inherited from class org.incava.doctorj.ItemDocAnalyzer

addDictionary, addUndocumentedViolation, checkForTagDescription, checkJavadoc, 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, addViolation, getReport

Field Details

MSG_SERIALDATA_WITHOUT_DESCRIPTION

public static final String MSG_SERIALDATA_WITHOUT_DESCRIPTION

Constructor Details

FunctionDocAnalyzer

public FunctionDocAnalyzer(Report r,
                           net.sourceforge.pmd.ast.SimpleNode node)

Method Details

checkJavadoc

protected void checkJavadoc(JavadocNode javadoc)
Overrides:
checkJavadoc in interface ItemDocAnalyzer

getParameterList

protected abstract net.sourceforge.pmd.ast.ASTFormalParameters getParameterList()
Returns the parameter list for the function.