|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD | DETAIL: FIELD | PROPERTY | CONSTR | METHOD |
java.lang.Objectorg.codenarc.rule.AbstractRule
groovy.org.codenarc.rule.formatting.ClassJavadocRule
class ClassJavadocRule extends AbstractRule
Makes sure each class and interface definition is preceeded by javadoc. Enum definitions are not checked, due to strange behavior in the Groovy AST.
Property Summary | |
---|---|
boolean |
applyToNonMainClasses
|
String |
name
|
int |
priority
|
Method Summary | |
---|---|
void
|
applyTo(SourceCode sourceCode, List violations)
Apply the rule to the given source, writing violations to the given list. |
Property Detail |
---|
boolean applyToNonMainClasses
String name
int priority
Method Detail |
---|
@Override @SuppressWarnings('EmptyWhileStatement') void applyTo(SourceCode sourceCode, List violations)
sourceCode
- The source to checkviolations
- A list of Violations that may be added to. It can be
an empty list
Groovy Documentation