Fix javadoc errors

This commit is contained in:
Andreas Dangel
2016-06-25 17:40:48 +02:00
parent c7b94f6e5c
commit 7d928296e6
2 changed files with 29 additions and 16 deletions

View File

@ -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.
* <p/>
*
* <p>
* It expects all "visit" calls to return an Integer. It will sum all the values
* it gets, and use that as its score.
* <p/>
* </p>
*
* <p>
* To use it, override the "visit" for the nodes that need to be counted. On
* those return "new Integer(1)"
* <p/>
* </p>
*
* <p>
* All others will return 0 (or the sum of counted nodes underneath.)
* </p>
*/
public class ExcessiveNodeCountRule extends AbstractStatisticalApexRule {

View File

@ -14,19 +14,26 @@ import net.sourceforge.pmd.util.NumericConstants;
/**
* @author ported from Java original of aglover
* <p/>
* Class Name: ExcessivePublicCount
* <p/>
* Rule attempts to count all public methods and public attributes
* defined in a class.
* <p/>
* 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.
* <p/>
* 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.
* <p>
* Class Name: ExcessivePublicCount
* </p>
*
* <p>
* Rule attempts to count all public methods and public attributes
* defined in a class.
* </p>
*
* <p>
* 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.
* </p>
*
* <p>
* 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.
* </p>
*/
public class ExcessivePublicCountRule extends ExcessiveNodeCountRule {