|
||||||||||
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
public abstract class ItemDocAnalyzer
Analyzes Javadoc and code.
Field Summary | |
---|---|
protected static int |
CHKLVL_MISORDERED_TAGS
|
protected static int |
CHKLVL_SUMMARY_SENTENCE
|
protected static int |
CHKLVL_VALID_TAGS
|
static java.lang.String |
MSG_DEPRECATED_WITHOUT_TEXT
|
static java.lang.String |
MSG_NO_SUMMARY_SENTENCE
|
static java.lang.String |
MSG_SEE_WITHOUT_REFERENCE
|
static java.lang.String |
MSG_SINCE_WITHOUT_TEXT
|
static java.lang.String |
MSG_SUMMARY_SENTENCE_DOES_NOT_END_WITH_PERIOD
|
static java.lang.String |
MSG_SUMMARY_SENTENCE_TOO_SHORT
|
static java.lang.String |
MSG_TAG_IMPROPER_ORDER
|
static ItemCommentSpellCheck |
spellChecker
|
Fields inherited from class org.incava.doctorj.DocAnalyzer |
---|
CHKLVL_DOC_EXISTS, CHKLVL_TAG_CONTENT |
Constructor Summary | |
---|---|
ItemDocAnalyzer(Report r,
SimpleNode node)
|
Method Summary | |
---|---|
static void |
addDictionary(java.lang.String dictName)
|
protected abstract void |
addUndocumentedViolation(java.lang.String desc)
Adds a violation for this type of item, with the violation pointing to the name for this item. |
protected void |
checkForTagDescription(JavadocTaggedNode taggedNode,
java.lang.String msg)
|
protected void |
checkJavadoc(JavadocNode javadoc)
|
protected abstract SimpleNode |
getEnclosingNode()
Returns the node that contains the access and modifier tokens. |
protected abstract java.lang.String |
getItemType()
Returns the type of item this analyzer is operating on. |
protected JavadocNode |
getJavadoc()
Returns the Javadoc for the given node. |
protected SimpleNode |
getNode()
|
protected abstract java.util.List |
getValidTags()
Returns the valid tags, as strings, for this type of item. |
void |
run()
Runs the analysis. |
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_NO_SUMMARY_SENTENCE
public static final java.lang.String MSG_SUMMARY_SENTENCE_DOES_NOT_END_WITH_PERIOD
public static final java.lang.String MSG_SUMMARY_SENTENCE_TOO_SHORT
public static final java.lang.String MSG_SEE_WITHOUT_REFERENCE
public static final java.lang.String MSG_SINCE_WITHOUT_TEXT
public static final java.lang.String MSG_DEPRECATED_WITHOUT_TEXT
public static final java.lang.String MSG_TAG_IMPROPER_ORDER
protected static final int CHKLVL_SUMMARY_SENTENCE
protected static final int CHKLVL_MISORDERED_TAGS
protected static final int CHKLVL_VALID_TAGS
public static ItemCommentSpellCheck spellChecker
Constructor Detail |
---|
public ItemDocAnalyzer(Report r, SimpleNode node)
Method Detail |
---|
public static void addDictionary(java.lang.String dictName)
protected JavadocNode getJavadoc()
protected abstract SimpleNode getEnclosingNode()
public void run()
protected abstract void addUndocumentedViolation(java.lang.String desc)
protected void checkJavadoc(JavadocNode javadoc)
protected void checkForTagDescription(JavadocTaggedNode taggedNode, java.lang.String msg)
protected SimpleNode getNode()
protected abstract java.lang.String getItemType()
protected abstract java.util.List getValidTags()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |