org.incava.doctorj
public abstract class ItemDocAnalyzer extends DocAnalyzer
Field Summary | |
---|---|
protected static int | CHKLVL_MISORDERED_TAGS |
protected static int | CHKLVL_SUMMARY_SENTENCE |
protected static int | CHKLVL_VALID_TAGS |
static String | MSG_DEPRECATED_WITHOUT_TEXT |
static String | MSG_NO_SUMMARY_SENTENCE |
static String | MSG_SEE_WITHOUT_REFERENCE |
static String | MSG_SINCE_WITHOUT_TEXT |
static String | MSG_SUMMARY_SENTENCE_DOES_NOT_END_WITH_PERIOD |
static String | MSG_SUMMARY_SENTENCE_TOO_SHORT |
static String | MSG_TAG_IMPROPER_ORDER |
static ItemCommentSpellCheck | spellChecker |
Constructor Summary | |
---|---|
ItemDocAnalyzer(Report r, SimpleNode node) |
Method Summary | |
---|---|
static void | addDictionary(String dictName) |
protected abstract void | addUndocumentedViolation(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, String msg) |
protected void | checkJavadoc(JavadocNode javadoc) |
protected abstract SimpleNode | getEnclosingNode()
Returns the node that contains the access and modifier tokens. |
protected abstract 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 List | getValidTags()
Returns the valid tags, as strings, for this type of item. |
void | run()
Runs the analysis. |