org.incava.doctorj
Class TypeDocAnalyzer
public abstract class TypeDocAnalyzer
Analyzes Javadoc and code for a type, which is a class (concrete or abstract)
or an interface.
CHKLVL_MISORDERED_TAGS , CHKLVL_SUMMARY_SENTENCE , CHKLVL_VALID_TAGS , MSG_DEPRECATED_WITHOUT_TEXT , MSG_NO_SUMMARY_SENTENCE , MSG_SEE_WITHOUT_REFERENCE , MSG_SINCE_WITHOUT_TEXT , MSG_SUMMARY_SENTENCE_DOES_NOT_END_WITH_PERIOD , MSG_SUMMARY_SENTENCE_TOO_SHORT , MSG_TAG_IMPROPER_ORDER , spellChecker |
TypeDocAnalyzer(Report r, net.sourceforge.pmd.ast.ASTClassOrInterfaceDeclaration decl) - Creates an analyzer, but does not yet run.
|
protected void | addUndocumentedViolation(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 net.sourceforge.pmd.ast.SimpleNode | getEnclosingNode() - Returns the node that contains the access and modifier tokens.
|
MSG_AUTHOR_WITHOUT_NAME
public static final String MSG_AUTHOR_WITHOUT_NAME
The message for an author without a name.
MSG_SERIAL_WITHOUT_TEXT
public static final String MSG_SERIAL_WITHOUT_TEXT
The message for a serial field without a description.
MSG_VERSION_WITHOUT_TEXT
public static final String MSG_VERSION_WITHOUT_TEXT
The message for a version without associated text.
TypeDocAnalyzer
public TypeDocAnalyzer(Report r,
net.sourceforge.pmd.ast.ASTClassOrInterfaceDeclaration decl)
Creates an analyzer, but does not yet run.
getEnclosingNode
protected net.sourceforge.pmd.ast.SimpleNode getEnclosingNode()
Returns the node that contains the access and modifier tokens.
- getEnclosingNode in interface ItemDocAnalyzer