Package net.sourceforge.pmd.lang.java.rule.documentation

Class CommentRequiredRule

java.lang.Object

net.sourceforge.pmd.properties.AbstractPropertySource

net.sourceforge.pmd.lang.rule.AbstractRule

net.sourceforge.pmd.lang.java.rule.AbstractJavaRule

net.sourceforge.pmd.lang.java.rule.AbstractJavaRulechainRule

net.sourceforge.pmd.lang.java.rule.documentation.CommentRequiredRule

All Implemented Interfaces:

net.sourceforge.pmd.lang.ast.AstVisitor, JavaVisitor, net.sourceforge.pmd.lang.rule.Rule, net.sourceforge.pmd.properties.PropertySource

public class CommentRequiredRule
extends AbstractJavaRulechainRule

Author:

Brian Remedios

Field Summary

Fields inherited from interface net.sourceforge.pmd.lang.rule.Rule

VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
CommentRequiredRule()

Method Summary

Modifier and Type	Method	Description
String	dysfunctionReason()
void	start(net.sourceforge.pmd.reporting.RuleContext ctx)
Object	visit(ASTClassDeclaration decl, 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)

Methods inherited from class net.sourceforge.pmd.lang.java.rule.AbstractJavaRulechainRule

buildTargetSelector, visitJavaNode

Methods inherited from class net.sourceforge.pmd.lang.java.rule.AbstractJavaRule

apply, visitNode

Methods inherited from class net.sourceforge.pmd.lang.rule.AbstractRule

addExample, asCtx, deepCopy, end, equals, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getPriority, getPropertySourceType, getRuleClass, getRuleSetName, getSince, getTargetSelector, hashCode, isDeprecated, setDeprecated, setDescription, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setName, setPriority, setRuleClass, setRuleSetName, setSince

Methods inherited from class net.sourceforge.pmd.properties.AbstractPropertySource

definePropertyDescriptor, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, isPropertyOverridden, setProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sourceforge.pmd.lang.ast.AstVisitor

cannotVisit

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.JavaVisitor

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, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from interface net.sourceforge.pmd.properties.PropertySource

definePropertyDescriptor, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, isPropertyOverridden, setProperty

Methods inherited from interface net.sourceforge.pmd.lang.rule.Rule

initialize

Constructor Detail

CommentRequiredRule

public CommentRequiredRule()

Method Detail

start

public void start(net.sourceforge.pmd.reporting.RuleContext ctx)

Specified by:

start in interface net.sourceforge.pmd.lang.rule.Rule

Overrides:

start in class net.sourceforge.pmd.lang.rule.AbstractRule

visit

public Object visit(ASTClassDeclaration decl,
                    Object data)

visit

public Object visit(ASTConstructorDeclaration decl,
                    Object data)

visit

public Object visit(ASTMethodDeclaration decl,
                    Object data)

visit

public Object visit(ASTFieldDeclaration decl,
                    Object data)

visit

public Object visit(ASTEnumDeclaration decl,
                    Object data)

dysfunctionReason

public String dysfunctionReason()