Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD DETAIL: FIELD | PROPERTY | CONSTR | METHOD

groovy.org.codenarc.rule.formatting
[Groovy] Class ClassJavadocRule

java.lang.Object
  org.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.

Authors:
Hamlet D'Arcy
Geli Crick

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

applyToNonMainClasses

boolean applyToNonMainClasses

name

String name

priority

int priority

 
Method Detail

applyTo

@Override
@SuppressWarnings('EmptyWhileStatement')
void applyTo(SourceCode sourceCode, List violations)
Apply the rule to the given source, writing violations to the given list.
Parameters:
sourceCode - The source to check
violations - A list of Violations that may be added to. It can be an empty list

 

Groovy Documentation