[jboss-svn-commits] JBL Code SVN: r24094 - labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule.

[jboss-svn-commits at lists.jboss.org]

Author: mark.proctor at jboss.com
Date: 2008-11-25 11:18:55 -0500 (Tue, 25 Nov 2008)
New Revision: 24094

Modified:
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule/StatefulRuleSession.java
Log:
-javadoc corrections

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule/StatefulRuleSession.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule/StatefulRuleSession.java	2008-11-25 16:16:57 UTC (rev 24093)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule/StatefulRuleSession.java	2008-11-25 16:18:55 UTC (rev 24094)
@@ -9,7 +9,7 @@
 public interface StatefulRuleSession {
 
     /**
-     * Fire all Activations on the Agenda
+     * Fire all Activations on the Agenda.
      * @return
      *     returns the number of rules fired
      */
@@ -41,7 +41,8 @@
     /**
      * Keeps firing activations until a halt is called. If in a given moment,
      * there is no activation to fire, it will wait for an activation to be
-     * added to an active agenda group or rule flow group.
+     * added to an active agenda group or rule flow group. This blocks the thread
+     * until halt is called.
      * 
      * @throws IllegalStateException
      *             if this method is called when running in sequential mode
@@ -51,7 +52,8 @@
     /**
      * Keeps firing activations until a halt is called. If in a given moment,
      * there is no activation to fire, it will wait for an activation to be
-     * added to an active agenda group or rule flow group.
+     * added to an active agenda group or rule flow group. This blocks the thread
+     * until halt is called.
      * 
      * @param agendaFilter
      *            filters the activations that may fire