org.incava.doctorj

Class CtorDocAnalyzer

public class CtorDocAnalyzer extends FunctionDocAnalyzer

Analyzes Javadoc and code for constructors.
Constructor Summary
CtorDocAnalyzer(Report r, ASTConstructorDeclaration ctor)
Method Summary
protected voidaddUndocumentedViolation(String desc)
Adds a violation for a constructor, with the violation pointing to the constructor name.
protected SimpleNodegetEnclosingNode()
StringgetItemType()
protected ASTFormalParametersgetParameterList()
Returns the throws list for the constructor.
protected ListgetValidTags()
Returns the valid tags, as strings, for ctors.

Constructor Detail

CtorDocAnalyzer

public CtorDocAnalyzer(Report r, ASTConstructorDeclaration ctor)

Method Detail

addUndocumentedViolation

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

getEnclosingNode

protected SimpleNode getEnclosingNode()

getItemType

public String getItemType()

getParameterList

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

getValidTags

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