diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveNodeCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveNodeCountRule.java index 7749cd5fd8..1ca9ae84f3 100644 --- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveNodeCountRule.java +++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveNodeCountRule.java @@ -10,14 +10,20 @@ import net.sourceforge.pmd.stat.DataPoint; /** * This is a common super class for things which shouldn't have excessive nodes * underneath. - *
+ * + ** It expects all "visit" calls to return an Integer. It will sum all the values * it gets, and use that as its score. - *
+ * + * + ** To use it, override the "visit" for the nodes that need to be counted. On * those return "new Integer(1)" - *
+ * + * + ** All others will return 0 (or the sum of counted nodes underneath.) + *
*/ public class ExcessiveNodeCountRule extends AbstractStatisticalApexRule { diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessivePublicCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessivePublicCountRule.java index dceb51bf24..37bec0a9b8 100644 --- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessivePublicCountRule.java +++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessivePublicCountRule.java @@ -14,19 +14,26 @@ import net.sourceforge.pmd.util.NumericConstants; /** * @author ported from Java original of aglover - * - * Class Name: ExcessivePublicCount - * - * Rule attempts to count all public methods and public attributes - * defined in a class. - * - * If a class has a high number of public operations, it might be wise - * to consider whether it would be appropriate to divide it into - * subclasses. - * - * A large proportion of public members and operations means the class - * has high potential to be affected by external classes. Futhermore, - * increased effort will be required to thoroughly test the class. + *+ * Class Name: ExcessivePublicCount + *
+ * + *+ * Rule attempts to count all public methods and public attributes + * defined in a class. + *
+ * + *+ * If a class has a high number of public operations, it might be wise + * to consider whether it would be appropriate to divide it into + * subclasses. + *
+ * + *+ * A large proportion of public members and operations means the class + * has high potential to be affected by external classes. Futhermore, + * increased effort will be required to thoroughly test the class. + *
*/ public class ExcessivePublicCountRule extends ExcessiveNodeCountRule {