org.incava.doctorj

Class FieldDocAnalyzer

public class FieldDocAnalyzer extends ItemDocAnalyzer

Analyzes Javadoc and code for fields.

Field Summary
static String	MSG_SERIALFIELD_WITHOUT_DESCRIPTION
static String	MSG_SERIALFIELD_WITHOUT_NAME_TYPE_AND_DESCRIPTION
static String	MSG_SERIALFIELD_WITHOUT_TYPE_AND_DESCRIPTION

Constructor Summary
	FieldDocAnalyzer(Report r, ASTFieldDeclaration field)

Method Summary
protected void	addUndocumentedViolation(String desc) Adds a violation for a field, with the violation pointing to the field name.
protected void	checkJavadoc(JavadocNode javadoc)
protected SimpleNode	getEnclosingNode()
String	getItemType()
protected List	getValidTags() Returns the valid tags, as strings, for fields.

Field Detail

MSG_SERIALFIELD_WITHOUT_DESCRIPTION

public static final String MSG_SERIALFIELD_WITHOUT_DESCRIPTION

MSG_SERIALFIELD_WITHOUT_NAME_TYPE_AND_DESCRIPTION

public static final String MSG_SERIALFIELD_WITHOUT_NAME_TYPE_AND_DESCRIPTION

MSG_SERIALFIELD_WITHOUT_TYPE_AND_DESCRIPTION

public static final String MSG_SERIALFIELD_WITHOUT_TYPE_AND_DESCRIPTION

Constructor Detail

FieldDocAnalyzer

public FieldDocAnalyzer(Report r, ASTFieldDeclaration field)

Method Detail

addUndocumentedViolation

protected void addUndocumentedViolation(String desc)

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

checkJavadoc

protected void checkJavadoc(JavadocNode javadoc)

getEnclosingNode

protected SimpleNode getEnclosingNode()

getItemType

public String getItemType()

getValidTags

protected List getValidTags()

Returns the valid tags, as strings, for fields.