class ClassJavadocRule extends AbstractRule
Makes sure each class and interface definition is preceded by javadoc. Enum definitions are not checked, due to strange behavior in the Groovy AST.
| Type | Name and description |
|---|---|
boolean |
applyToNonMainClasses |
java.lang.String |
name |
int |
priority |
| Constructor and description |
|---|
ClassJavadocRule
() |
| Type Params | Return Type | Name and description |
|---|---|---|
|
void |
applyTo(SourceCode sourceCode, java.util.List<Violation> violations)Apply the rule to the given source, writing violations to the given list. |
|
protected java.lang.String |
sourceCodeNameWithoutExtension(SourceCode sourceCode) |
| Methods inherited from class | Name |
|---|---|
class AbstractRule |
applyTo, applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getName, getPriority, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setName, setPriority, setViolationMessage, toString, validate |
Apply the rule to the given source, writing violations to the given list.
sourceCode - The source to checkviolations - A list of Violations that may be added to. It can be an empty listGroovy Documentation