public class CommentRequiredRule extends AbstractCommentRule
Modifier and Type | Field and Description |
---|---|
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, propertyValuesByDescriptor
VIOLATION_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(ASTCompilationUnit cUnit,
Object data) |
filteredCommentIn, orderedCommentsAndDeclarations, tagsIndicesIn
apply, 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, visit, visit, visit, visitAll
addExample, 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, usesTypeResolution
copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, useDefaultValueFor, usesDefaultValues
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
definePropertyDescriptor, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, useDefaultValueFor, usesDefaultValues
public 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 Object visit(ASTCompilationUnit cUnit, Object data)
visit
in interface JavaParserVisitor
visit
in class AbstractJavaRule
public boolean allCommentsAreIgnored()
public String dysfunctionReason()
PropertySource
dysfunctionReason
in interface PropertySource
dysfunctionReason
in class AbstractPropertySource
PropertySource.dysfunctionReason()
Copyright © 2002-2015 InfoEther. All Rights Reserved.