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 void	addUndocumentedViolation(String desc) Adds a violation for a constructor, with the violation pointing to the constructor name.
protected SimpleNode	getEnclosingNode()
String	getItemType()
protected ASTFormalParameters	getParameterList() Returns the throws list for the constructor.
protected List	getValidTags() Returns the valid tags, as strings, for ctors.

Constructor Detail

public CtorDocAnalyzer(Report r, ASTConstructorDeclaration ctor)

protected void addUndocumentedViolation(String desc)

Adds a violation for a constructor, with the violation pointing to the constructor name.

protected SimpleNode getEnclosingNode()

public String getItemType()

protected ASTFormalParameters getParameterList()

Returns the throws list for the constructor.

protected List getValidTags()

Returns the valid tags, as strings, for ctors.