[jbpm-commits] JBoss JBPM SVN: r3763 - jbpm4/trunk/modules/api/src/main/java/org/jbpm/activity.

[do-not-reply at jboss.org]

Author: tom.baeyens at jboss.com
Date: 2009-02-04 02:36:48 -0500 (Wed, 04 Feb 2009)
New Revision: 3763

Modified:
   jbpm4/trunk/modules/api/src/main/java/org/jbpm/activity/ActivityBehaviour.java
Log:
improved javadocs

Modified: jbpm4/trunk/modules/api/src/main/java/org/jbpm/activity/ActivityBehaviour.java
===================================================================
--- jbpm4/trunk/modules/api/src/main/java/org/jbpm/activity/ActivityBehaviour.java	2009-02-04 07:36:06 UTC (rev 3762)
+++ jbpm4/trunk/modules/api/src/main/java/org/jbpm/activity/ActivityBehaviour.java	2009-02-04 07:36:48 UTC (rev 3763)
@@ -33,15 +33,16 @@
   /** piece of Java code that is to be included in a process as activity behaviour 
    * or as a hidden listener to process events.
    * 
-   * <p>Activities can be used to implement the behaviour of activities, in 
+   * <p>ActivityBehaviour's can be used to implement the behaviour of activities, in 
    * which case this behaviour is associated to a graphical activity in the diagram,
    * or they can be added as events, in that case, they are being hidden from 
    * the diagram.
    * </p>
    * 
-   * <p>If an activity is the activity behaviour, then it can control the propagation 
-   * of execution.  Activity behaviours can be external activities.  That means their 
-   * runtime behaviour is a wait state.  In that case, {@link ExternalActivityBehaviour} 
+   * <p>An ActivityBehaviour can control the propagation 
+   * of execution.  ActivityBehaviour's can become external activities when they 
+   * invoke {@link ActivityExecution#waitForSignal()}.  That means the 
+   * activity will become a wait state.  In that case, {@link ExternalActivityBehaviour} 
    * should be implemented to also handle the external triggers. 
    * </p>
    */