diff --git a/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/Rule.java b/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/Rule.java index 0dc66e9..ffc874e 100644 --- a/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/Rule.java +++ b/builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/Rule.java @@ -11,7 +11,7 @@ import java.util.List; import java.util.Map; /** - * . + * A single Checkstyle Check. * * @author Paul Campbell (paul.campbell@hubio.com) */ @@ -20,19 +20,43 @@ import java.util.Map; @Getter public class Rule { + /** + * The name of the rule's Check class. + */ private String name; + /** + * The parent module. + */ private RuleParent parent; + /** + * The first level the rule is enabled on. + */ private RuleLevel level; + /** + * Whether the rule is enabled. + */ private boolean enabled; + /** + * The source of the rule. + */ private RuleSource source; + /** + * URI for full official documentation. + */ private URI uri; + /** + * Configuration properties. + */ private Map properties = new HashMap<>(); + /** + * Unofficial documentation. + */ private List body = new ArrayList<>(); }