org.incava.doctorj

Class CtorDocAnalyzer


public class CtorDocAnalyzer
extends FunctionDocAnalyzer

Analyzes Javadoc and code for constructors.

Field Summary

Fields inherited from class org.incava.doctorj.FunctionDocAnalyzer

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

CtorDocAnalyzer(Report r, net.sourceforge.pmd.ast.ASTConstructorDeclaration ctor)

Method Summary

protected void
addUndocumentedViolation(String desc)
Adds a violation for a constructor, with the violation pointing to the constructor name.
protected net.sourceforge.pmd.ast.SimpleNode
getEnclosingNode()
Returns the node that contains the access and modifier tokens.
String
getItemType()
Returns the type of item this analyzer is operating on.
protected net.sourceforge.pmd.ast.ASTFormalParameters
getParameterList()
Returns the throws list for the constructor.
protected List
getValidTags()
Returns the valid tags, as strings, for ctors.

Methods inherited from class org.incava.doctorj.FunctionDocAnalyzer

checkJavadoc, getParameterList

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

CtorDocAnalyzer

public CtorDocAnalyzer(Report r,
                       net.sourceforge.pmd.ast.ASTConstructorDeclaration ctor)

Method Details

addUndocumentedViolation

protected void addUndocumentedViolation(String desc)
Adds a violation for a constructor, with the violation pointing to the constructor name.
Overrides:
addUndocumentedViolation in interface ItemDocAnalyzer

getEnclosingNode

protected net.sourceforge.pmd.ast.SimpleNode getEnclosingNode()
Returns the node that contains the access and modifier tokens.
Overrides:
getEnclosingNode in interface ItemDocAnalyzer

getItemType

public String getItemType()
Returns the type of item this analyzer is operating on.
Overrides:
getItemType in interface ItemDocAnalyzer

getParameterList

protected net.sourceforge.pmd.ast.ASTFormalParameters getParameterList()
Returns the throws list for the constructor.
Overrides:
getParameterList in interface FunctionDocAnalyzer

getValidTags

protected List getValidTags()
Returns the valid tags, as strings, for ctors.
Overrides:
getValidTags in interface ItemDocAnalyzer