org.incava.doctorj
Class CtorDocAnalyzer

java.lang.Object
  extended by org.incava.analysis.Analyzer
      extended by org.incava.doctorj.DocAnalyzer
          extended by org.incava.doctorj.ItemDocAnalyzer
              extended by org.incava.doctorj.FunctionDocAnalyzer
                  extended by org.incava.doctorj.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, ASTConstructorDeclaration ctor)
           
 
Method Summary
protected  void addUndocumentedViolation(java.lang.String desc)
          Adds a violation for a constructor, with the violation pointing to the constructor name.
protected  SimpleNode getEnclosingNode()
          Returns the node that contains the access and modifier tokens.
 java.lang.String getItemType()
          Returns the type of item this analyzer is operating on.
protected  ASTFormalParameters getParameterList()
          Returns the throws list for the constructor.
protected  java.util.List getValidTags()
          Returns the valid tags, as strings, for ctors.
 
Methods inherited from class org.incava.doctorj.FunctionDocAnalyzer
checkJavadoc
 
Methods inherited from class org.incava.doctorj.ItemDocAnalyzer
addDictionary, checkForTagDescription, getJavadoc, getNode, 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
 

Constructor Detail

CtorDocAnalyzer

public CtorDocAnalyzer(Report r,
                       ASTConstructorDeclaration ctor)
Method Detail

getItemType

public java.lang.String getItemType()
Description copied from class: ItemDocAnalyzer
Returns the type of item this analyzer is operating on.

Specified by:
getItemType in class ItemDocAnalyzer

getParameterList

protected ASTFormalParameters getParameterList()
Returns the throws list for the constructor.

Specified by:
getParameterList in class FunctionDocAnalyzer

getValidTags

protected java.util.List getValidTags()
Returns the valid tags, as strings, for ctors.

Specified by:
getValidTags in class ItemDocAnalyzer

addUndocumentedViolation

protected void addUndocumentedViolation(java.lang.String desc)
Adds a violation for a constructor, with the violation pointing to the constructor name.

Specified by:
addUndocumentedViolation in class ItemDocAnalyzer

getEnclosingNode

protected SimpleNode getEnclosingNode()
Description copied from class: ItemDocAnalyzer
Returns the node that contains the access and modifier tokens.

Specified by:
getEnclosingNode in class ItemDocAnalyzer