From 5ba3fbbf6c1dd80725f8b7e14ef827c2f6299341 Mon Sep 17 00:00:00 2001
From: Xavier Le Vourch <xlv@users.sourceforge.net>
Date: Wed, 24 Oct 2007 18:11:20 +0000
Subject: [PATCH] javadoc comments added

git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@5574 51baf565-9d33-0410-a72c-fc3788e3496d
---
 .../sourceforge/pmd/testframework/SimpleAggregatorTst.java | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/pmd/regress/test/net/sourceforge/pmd/testframework/SimpleAggregatorTst.java b/pmd/regress/test/net/sourceforge/pmd/testframework/SimpleAggregatorTst.java
index 4bc2c29a64..f3b3fb9917 100644
--- a/pmd/regress/test/net/sourceforge/pmd/testframework/SimpleAggregatorTst.java
+++ b/pmd/regress/test/net/sourceforge/pmd/testframework/SimpleAggregatorTst.java
@@ -43,10 +43,17 @@ public abstract class SimpleAggregatorTst extends RuleTst {
 
     private List<Rule> rules = new ArrayList<Rule>();
 
+    /**
+     * Add new XML tests associated with the rule to the test suite. This should
+     * be called from the setup method.
+     */
     protected void addRule(String ruleSet, String ruleName) {
         rules.add(findRule(ruleSet, ruleName));
     }
 
+    /**
+     * Run a set of tests for all rules added in the setup method.
+     */
     @Test
     public void testAll() {
         for (Rule r : rules) {