Class InterfaceDocAnalyzer

Field Summary

Fields inherited from class org.incava.doctorj.TypeDocAnalyzer

MSG_AUTHOR_WITHOUT_NAME, MSG_SERIAL_WITHOUT_TEXT, MSG_VERSION_WITHOUT_TEXT

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

InterfaceDocAnalyzer(Report r, net.sourceforge.pmd.ast.ASTClassOrInterfaceDeclaration node) Creates an analyzer, but does not yet run.

Method Summary
String	getItemType() Returns the type of item this analyzer is operating on.
protected List	getValidTags() Returns the valid tags, as strings, for interfaces.

Methods inherited from class org.incava.doctorj.TypeDocAnalyzer

addUndocumentedViolation, checkJavadoc, getEnclosingNode

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

Constructor Details

Method Details