public class CommentRequiredRule extends AbstractCommentRule
| Modifier and Type | Field and Description |
|---|---|
static EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> |
ENUM_CMT_REQUIREMENT_DESCRIPTOR |
static EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> |
FIELD_CMT_REQUIREMENT_DESCRIPTOR |
static EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> |
HEADER_CMT_REQUIREMENT_DESCRIPTOR |
static EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> |
PROT_METHOD_CMT_REQUIREMENT_DESCRIPTOR |
static EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> |
PUB_METHOD_CMT_REQUIREMENT_DESCRIPTOR |
propertyDescriptors, propertyValuesByDescriptorVIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR| Constructor and Description |
|---|
CommentRequiredRule() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
allCommentsAreIgnored() |
String |
dysfunctionReason()
Returns a description of why the receiver may be dysfunctional.
|
Object |
visit(ASTClassOrInterfaceDeclaration decl,
Object data) |
Object |
visit(ASTCompilationUnit cUnit,
Object data) |
Object |
visit(ASTConstructorDeclaration decl,
Object data) |
Object |
visit(ASTEnumDeclaration decl,
Object data) |
Object |
visit(ASTFieldDeclaration decl,
Object data) |
Object |
visit(ASTMethodDeclaration decl,
Object data) |
assignCommentsToDeclarations, filteredCommentIn, orderedCommentsAndDeclarations, tagsIndicesInapply, getDeclaringType, importsPackage, isQualifiedName, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitAlladdExample, addRuleChainVisit, addRuleChainVisit, addViolation, addViolation, addViolation, addViolationWithMessage, addViolationWithMessage, addViolationWithMessage, deepCopyValuesTo, end, equals, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getParserOptions, getPriority, getRuleChainVisits, getRuleClass, getRuleSetName, getSince, hashCode, isDeprecated, setDeprecated, setDescription, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setName, setPriority, setRuleClass, setRuleSetName, setSince, setUsesDFA, setUsesTypeResolution, start, usesDFA, usesRuleChain, usesTypeResolutioncopyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, useDefaultValueFor, usesDefaultValuesclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitdefinePropertyDescriptor, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, useDefaultValueFor, usesDefaultValuespublic static final EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> HEADER_CMT_REQUIREMENT_DESCRIPTOR
public static final EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> FIELD_CMT_REQUIREMENT_DESCRIPTOR
public static final EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> PUB_METHOD_CMT_REQUIREMENT_DESCRIPTOR
public static final EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> PROT_METHOD_CMT_REQUIREMENT_DESCRIPTOR
public static final EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> ENUM_CMT_REQUIREMENT_DESCRIPTOR
public Object visit(ASTClassOrInterfaceDeclaration decl, Object data)
visit in interface JavaParserVisitorvisit in class AbstractJavaRulepublic Object visit(ASTConstructorDeclaration decl, Object data)
visit in interface JavaParserVisitorvisit in class AbstractJavaRulepublic Object visit(ASTMethodDeclaration decl, Object data)
visit in interface JavaParserVisitorvisit in class AbstractJavaRulepublic Object visit(ASTFieldDeclaration decl, Object data)
visit in interface JavaParserVisitorvisit in class AbstractJavaRulepublic Object visit(ASTEnumDeclaration decl, Object data)
visit in interface JavaParserVisitorvisit in class AbstractJavaRulepublic Object visit(ASTCompilationUnit cUnit, Object data)
visit in interface JavaParserVisitorvisit in class AbstractJavaRulepublic boolean allCommentsAreIgnored()
public String dysfunctionReason()
AbstractPropertySourcedysfunctionReason in interface PropertySourcedysfunctionReason in class AbstractPropertySourcePropertySource.dysfunctionReason()Copyright © 2002-2014 InfoEther. All Rights Reserved.