public class CtorDocAnalyzer extends FunctionDocAnalyzer
MSG_SERIALDATA_WITHOUT_DESCRIPTION
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
CHKLVL_DOC_EXISTS, CHKLVL_TAG_CONTENT
Constructor and Description |
---|
CtorDocAnalyzer(Report r,
ASTConstructorDeclaration ctor) |
Modifier and Type | Method and Description |
---|---|
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.
|
checkJavadoc
addDictionary, checkForTagDescription, getJavadoc, getNode, run
isCheckable
addViolation, addViolation, addViolation, getReport
public CtorDocAnalyzer(Report r, ASTConstructorDeclaration ctor)
public java.lang.String getItemType()
ItemDocAnalyzer
getItemType
in class ItemDocAnalyzer
protected ASTFormalParameters getParameterList()
getParameterList
in class FunctionDocAnalyzer
protected java.util.List getValidTags()
getValidTags
in class ItemDocAnalyzer
protected void addUndocumentedViolation(java.lang.String desc)
addUndocumentedViolation
in class ItemDocAnalyzer
protected SimpleNode getEnclosingNode()
ItemDocAnalyzer
getEnclosingNode
in class ItemDocAnalyzer