|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.incava.analysis.Analyzer
org.incava.doctorj.DocAnalyzer
org.incava.doctorj.ItemDocAnalyzer
org.incava.doctorj.TypeDocAnalyzer
public abstract class TypeDocAnalyzer
Analyzes Javadoc and code for a type, which is a class (concrete or abstract) or an interface.
Field Summary | |
---|---|
static java.lang.String |
MSG_AUTHOR_WITHOUT_NAME
The message for an author without a name. |
static java.lang.String |
MSG_SERIAL_WITHOUT_TEXT
The message for a serial field without a description. |
static java.lang.String |
MSG_VERSION_WITHOUT_TEXT
The message for a version without associated text. |
Fields inherited from class org.incava.doctorj.DocAnalyzer |
---|
CHKLVL_DOC_EXISTS, CHKLVL_TAG_CONTENT |
Constructor Summary | |
---|---|
TypeDocAnalyzer(Report r,
ASTClassOrInterfaceDeclaration decl)
Creates an analyzer, but does not yet run. |
Method Summary | |
---|---|
protected void |
addUndocumentedViolation(java.lang.String desc)
Adds a violation, for something that is not documented. |
protected void |
checkJavadoc(JavadocNode javadoc)
Checks the Javadoc against that expected by a type. |
protected SimpleNode |
getEnclosingNode()
Returns the node that contains the access and modifier tokens. |
Methods inherited from class org.incava.doctorj.ItemDocAnalyzer |
---|
addDictionary, checkForTagDescription, getItemType, getJavadoc, getNode, getValidTags, 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 |
Field Detail |
---|
public static final java.lang.String MSG_AUTHOR_WITHOUT_NAME
public static final java.lang.String MSG_VERSION_WITHOUT_TEXT
public static final java.lang.String MSG_SERIAL_WITHOUT_TEXT
Constructor Detail |
---|
public TypeDocAnalyzer(Report r, ASTClassOrInterfaceDeclaration decl)
Method Detail |
---|
protected void checkJavadoc(JavadocNode javadoc)
checkJavadoc
in class ItemDocAnalyzer
protected void addUndocumentedViolation(java.lang.String desc)
addUndocumentedViolation
in class ItemDocAnalyzer
protected SimpleNode getEnclosingNode()
ItemDocAnalyzer
getEnclosingNode
in class ItemDocAnalyzer
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |