Package org.codenarc.rule.comments
Class JavadocMissingParamDescriptionRule
java.lang.Object
org.codenarc.rule.AbstractRule
org.codenarc.rule.AbstractAstVisitorRule
org.codenarc.rule.comments.AbstractJavadocMissingDescriptionRule
org.codenarc.rule.comments.JavadocMissingParamDescriptionRule
- All Implemented Interfaces:
groovy.lang.GroovyObject
,Rule
-
Field Summary
Fields inherited from class org.codenarc.rule.AbstractAstVisitorRule
CLOSURE_TEXT, DEFAULT_CONST_NAME, DEFAULT_FIELD_NAME, DEFAULT_TEST_CLASS_NAMES, DEFAULT_TEST_FILES, DEFAULT_VAR_NAME
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongroovy.lang.MetaClass
getName()
getProperty
(String property) protected String
getTag()
invokeMethod
(String method, Object arguments) void
setMetaClass
(groovy.lang.MetaClass mc) void
Set the unique name for this rulevoid
setProperty
(String property, Object value) Methods inherited from class org.codenarc.rule.comments.AbstractJavadocMissingDescriptionRule
applyTo, getAllowMultiline, getPriority, isAllowMultiline, setAllowMultiline, setPriority
Methods inherited from class org.codenarc.rule.AbstractAstVisitorRule
getApplyToClassNames, getAstVisitor, getAstVisitorClass, getDoNotApplyToClassNames, setApplyToClassNames, setDoNotApplyToClassNames, shouldApplyThisRuleTo
Methods inherited from class org.codenarc.rule.AbstractRule
applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString, validate
-
Constructor Details
-
JavadocMissingParamDescriptionRule
public JavadocMissingParamDescriptionRule()
-
-
Method Details
-
getMetaClass
public groovy.lang.MetaClass getMetaClass()- Specified by:
getMetaClass
in interfacegroovy.lang.GroovyObject
- Overrides:
getMetaClass
in classAbstractJavadocMissingDescriptionRule
-
setMetaClass
public void setMetaClass(groovy.lang.MetaClass mc) - Specified by:
setMetaClass
in interfacegroovy.lang.GroovyObject
- Overrides:
setMetaClass
in classAbstractJavadocMissingDescriptionRule
-
invokeMethod
- Specified by:
invokeMethod
in interfacegroovy.lang.GroovyObject
- Overrides:
invokeMethod
in classAbstractJavadocMissingDescriptionRule
-
getProperty
- Specified by:
getProperty
in interfacegroovy.lang.GroovyObject
- Overrides:
getProperty
in classAbstractJavadocMissingDescriptionRule
-
setProperty
- Specified by:
setProperty
in interfacegroovy.lang.GroovyObject
- Overrides:
setProperty
in classAbstractJavadocMissingDescriptionRule
-
getName
- Specified by:
getName
in interfaceRule
- Specified by:
getName
in classAbstractRule
- Returns:
- the unique name for this rule
-
setName
Description copied from class:AbstractRule
Set the unique name for this rule- Specified by:
setName
in classAbstractRule
- Parameters:
value
- - the name for this rule; this should be unique
-
getTag
- Specified by:
getTag
in classAbstractJavadocMissingDescriptionRule
-