|
||||||||||
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
org.incava.doctorj.InterfaceDocAnalyzer
public class InterfaceDocAnalyzer
Analyzes Javadoc and code for an interface.
Field Summary |
---|
Fields inherited from class org.incava.doctorj.TypeDocAnalyzer |
---|
MSG_AUTHOR_WITHOUT_NAME, MSG_SERIAL_WITHOUT_TEXT, MSG_VERSION_WITHOUT_TEXT |
Fields inherited from class org.incava.doctorj.DocAnalyzer |
---|
CHKLVL_DOC_EXISTS, CHKLVL_TAG_CONTENT |
Constructor Summary | |
---|---|
InterfaceDocAnalyzer(Report r,
ASTClassOrInterfaceDeclaration node)
|
Method Summary | |
---|---|
java.lang.String |
getItemType()
Returns the type of item this analyzer is operating on. |
protected java.util.List |
getValidTags()
Returns the valid tags, as strings, for interfaces. |
Methods inherited from class org.incava.doctorj.TypeDocAnalyzer |
---|
addUndocumentedViolation, checkJavadoc, getEnclosingNode |
Methods inherited from class org.incava.doctorj.ItemDocAnalyzer |
---|
addDictionary, checkForTagDescription, getJavadoc, getNode, 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 |
Constructor Detail |
---|
public InterfaceDocAnalyzer(Report r, ASTClassOrInterfaceDeclaration node)
Method Detail |
---|
public java.lang.String getItemType()
ItemDocAnalyzer
getItemType
in class ItemDocAnalyzer
protected java.util.List getValidTags()
getValidTags
in class ItemDocAnalyzer
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |