Author: sb
Date: Tue Jan 29 12:30:56 2008
New Revision: 7253
Log:
- Fix docblocks.
Modified:
trunk/Workflow/src/interfaces/node.php
trunk/Workflow/src/interfaces/node_branch.php
trunk/Workflow/src/interfaces/node_conditional_branch.php
trunk/Workflow/src/interfaces/node_merge.php
trunk/Workflow/src/nodes/action.php
trunk/Workflow/src/nodes/control_flow/discriminator.php
trunk/Workflow/src/nodes/control_flow/parallel_split.php
trunk/Workflow/src/nodes/control_flow/simple_merge.php
trunk/Workflow/src/nodes/control_flow/synchronization.php
trunk/Workflow/src/nodes/end.php
trunk/Workflow/src/nodes/start.php
trunk/Workflow/src/nodes/sub_workflow.php
trunk/Workflow/src/nodes/variables/add.php
trunk/Workflow/src/nodes/variables/decrement.php
trunk/Workflow/src/nodes/variables/div.php
trunk/Workflow/src/nodes/variables/increment.php
trunk/Workflow/src/nodes/variables/input.php
trunk/Workflow/src/nodes/variables/mul.php
trunk/Workflow/src/nodes/variables/set.php
trunk/Workflow/src/nodes/variables/sub.php
trunk/Workflow/src/nodes/variables/unset.php
Modified: trunk/Workflow/src/interfaces/node.php
==============================================================================
--- trunk/Workflow/src/interfaces/node.php [iso-8859-1] (original)
+++ trunk/Workflow/src/interfaces/node.php [iso-8859-1] Tue Jan 29 12:30:56 2008
@@ -586,6 +586,7 @@
* Generate node configuration from XML representation.
*
* @param DOMElement $element
+ * @ignore
*/
public static function configurationFromXML( DOMElement $element )
{
@@ -595,6 +596,7 @@
* Generate XML representation of this node's configuration.
*
* @param DOMElement $element
+ * @ignore
*/
public function configurationToXML( DOMElement $element )
{
Modified: trunk/Workflow/src/interfaces/node_branch.php
==============================================================================
--- trunk/Workflow/src/interfaces/node_branch.php [iso-8859-1] (original)
+++ trunk/Workflow/src/interfaces/node_branch.php [iso-8859-1] Tue Jan 29
12:30:56 2008
@@ -36,7 +36,9 @@
* Activates this node's outgoing nodes.
*
* @param ezcWorkflowExecution $execution
- * @param array $nodes
+ * @param array $nodes
+ * @return boolean true when the node finished execution,
+ * and false otherwise
*/
protected function activateOutgoingNodes( ezcWorkflowExecution $execution,
Array $nodes )
{
Modified: trunk/Workflow/src/interfaces/node_conditional_branch.php
==============================================================================
--- trunk/Workflow/src/interfaces/node_conditional_branch.php [iso-8859-1]
(original)
+++ trunk/Workflow/src/interfaces/node_conditional_branch.php [iso-8859-1] Tue
Jan 29 12:30:56 2008
@@ -131,6 +131,8 @@
* passed through both checks and condition evaluation.
*
* @param ezcWorkflowExecution $execution
+ * @return boolean true when the node finished execution,
+ * and false otherwise
* @ignore
*/
public function execute( ezcWorkflowExecution $execution )
Modified: trunk/Workflow/src/interfaces/node_merge.php
==============================================================================
--- trunk/Workflow/src/interfaces/node_merge.php [iso-8859-1] (original)
+++ trunk/Workflow/src/interfaces/node_merge.php [iso-8859-1] Tue Jan 29
12:30:56 2008
@@ -73,6 +73,8 @@
* activating the outgoing node.
*
* @param ezcWorkflowExecution $execution
+ * @return boolean true when the node finished execution,
+ * and false otherwise
*/
protected function doMerge( ezcWorkflowExecution $execution )
{
Modified: trunk/Workflow/src/nodes/action.php
==============================================================================
--- trunk/Workflow/src/nodes/action.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/action.php [iso-8859-1] Tue Jan 29 12:30:56 2008
@@ -134,6 +134,8 @@
* Generate node configuration from XML representation.
*
* @param DOMElement $element
+ * @return array
+ * @ignore
*/
public static function configurationFromXML( DOMElement $element )
{
@@ -161,6 +163,7 @@
* Generate XML representation of this node's configuration.
*
* @param DOMElement $element
+ * @ignore
*/
public function configurationToXML( DOMElement $element )
{
Modified: trunk/Workflow/src/nodes/control_flow/discriminator.php
==============================================================================
--- trunk/Workflow/src/nodes/control_flow/discriminator.php [iso-8859-1]
(original)
+++ trunk/Workflow/src/nodes/control_flow/discriminator.php [iso-8859-1] Tue
Jan 29 12:30:56 2008
@@ -76,6 +76,8 @@
* Executes this node.
*
* @param ezcWorkflowExecution $execution
+ * @return boolean true when the node finished execution,
+ * and false otherwise
* @ignore
*/
public function execute( ezcWorkflowExecution $execution )
Modified: trunk/Workflow/src/nodes/control_flow/parallel_split.php
==============================================================================
--- trunk/Workflow/src/nodes/control_flow/parallel_split.php [iso-8859-1]
(original)
+++ trunk/Workflow/src/nodes/control_flow/parallel_split.php [iso-8859-1] Tue
Jan 29 12:30:56 2008
@@ -46,6 +46,8 @@
* Activates all outgoing nodes.
*
* @param ezcWorkflowExecution $execution
+ * @return boolean true when the node finished execution,
+ * and false otherwise
* @ignore
*/
public function execute( ezcWorkflowExecution $execution )
Modified: trunk/Workflow/src/nodes/control_flow/simple_merge.php
==============================================================================
--- trunk/Workflow/src/nodes/control_flow/simple_merge.php [iso-8859-1]
(original)
+++ trunk/Workflow/src/nodes/control_flow/simple_merge.php [iso-8859-1] Tue Jan
29 12:30:56 2008
@@ -81,6 +81,8 @@
* Executes this node.
*
* @param ezcWorkflowExecution $execution
+ * @return boolean true when the node finished execution,
+ * and false otherwise
* @ignore
*/
public function execute( ezcWorkflowExecution $execution )
Modified: trunk/Workflow/src/nodes/control_flow/synchronization.php
==============================================================================
--- trunk/Workflow/src/nodes/control_flow/synchronization.php [iso-8859-1]
(original)
+++ trunk/Workflow/src/nodes/control_flow/synchronization.php [iso-8859-1] Tue
Jan 29 12:30:56 2008
@@ -46,6 +46,8 @@
* Executes this node.
*
* @param ezcWorkflowExecution $execution
+ * @return boolean true when the node finished execution,
+ * and false otherwise
* @ignore
*/
public function execute( ezcWorkflowExecution $execution )
Modified: trunk/Workflow/src/nodes/end.php
==============================================================================
--- trunk/Workflow/src/nodes/end.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/end.php [iso-8859-1] Tue Jan 29 12:30:56 2008
@@ -53,6 +53,8 @@
* Ends the execution of this workflow.
*
* @param ezcWorkflowExecution $execution
+ * @return boolean true when the node finished execution,
+ * and false otherwise
* @ignore
*/
public function execute( ezcWorkflowExecution $execution )
Modified: trunk/Workflow/src/nodes/start.php
==============================================================================
--- trunk/Workflow/src/nodes/start.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/start.php [iso-8859-1] Tue Jan 29 12:30:56 2008
@@ -50,6 +50,8 @@
* Activates the sole output node.
*
* @param ezcWorkflowExecution $execution
+ * @return boolean true when the node finished execution,
+ * and false otherwise
* @ignore
*/
public function execute( ezcWorkflowExecution $execution )
Modified: trunk/Workflow/src/nodes/sub_workflow.php
==============================================================================
--- trunk/Workflow/src/nodes/sub_workflow.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/sub_workflow.php [iso-8859-1] Tue Jan 29 12:30:56
2008
@@ -96,6 +96,8 @@
* Executes this node.
*
* @param ezcWorkflowExecution $execution
+ * @return boolean true when the node finished execution,
+ * and false otherwise
* @ignore
*/
public function execute( ezcWorkflowExecution $execution )
@@ -180,6 +182,8 @@
* Generate node configuration from XML representation.
*
* @param DOMElement $element
+ * @return array
+ * @ignore
*/
public static function configurationFromXML( DOMElement $element )
{
@@ -211,6 +215,7 @@
* Generate XML representation of this node's configuration.
*
* @param DOMElement $element
+ * @ignore
*/
public function configurationToXML( DOMElement $element )
{
Modified: trunk/Workflow/src/nodes/variables/add.php
==============================================================================
--- trunk/Workflow/src/nodes/variables/add.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/variables/add.php [iso-8859-1] Tue Jan 29 12:30:56
2008
@@ -41,6 +41,8 @@
* Generate node configuration from XML representation.
*
* @param DOMElement $element
+ * @return array
+ * @ignore
*/
public static function configurationFromXML( DOMElement $element )
{
@@ -54,6 +56,7 @@
* Generate XML representation of this node's configuration.
*
* @param DOMElement $element
+ * @ignore
*/
public function configurationToXML( DOMElement $element )
{
Modified: trunk/Workflow/src/nodes/variables/decrement.php
==============================================================================
--- trunk/Workflow/src/nodes/variables/decrement.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/variables/decrement.php [iso-8859-1] Tue Jan 29
12:30:56 2008
@@ -42,6 +42,8 @@
* Generate node configuration from XML representation.
*
* @param DOMElement $element
+ * @return string
+ * @ignore
*/
public static function configurationFromXML( DOMElement $element )
{
@@ -52,6 +54,7 @@
* Generate XML representation of this node's configuration.
*
* @param DOMElement $element
+ * @ignore
*/
public function configurationToXML( DOMElement $element )
{
Modified: trunk/Workflow/src/nodes/variables/div.php
==============================================================================
--- trunk/Workflow/src/nodes/variables/div.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/variables/div.php [iso-8859-1] Tue Jan 29 12:30:56
2008
@@ -45,6 +45,8 @@
* Generate node configuration from XML representation.
*
* @param DOMElement $element
+ * @return array
+ * @ignore
*/
public static function configurationFromXML( DOMElement $element )
{
@@ -58,6 +60,7 @@
* Generate XML representation of this node's configuration.
*
* @param DOMElement $element
+ * @ignore
*/
public function configurationToXML( DOMElement $element )
{
Modified: trunk/Workflow/src/nodes/variables/increment.php
==============================================================================
--- trunk/Workflow/src/nodes/variables/increment.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/variables/increment.php [iso-8859-1] Tue Jan 29
12:30:56 2008
@@ -42,6 +42,8 @@
* Generate node configuration from XML representation.
*
* @param DOMElement $element
+ * @return string
+ * @ignore
*/
public static function configurationFromXML( DOMElement $element )
{
@@ -52,6 +54,7 @@
* Generate XML representation of this node's configuration.
*
* @param DOMElement $element
+ * @ignore
*/
public function configurationToXML( DOMElement $element )
{
Modified: trunk/Workflow/src/nodes/variables/input.php
==============================================================================
--- trunk/Workflow/src/nodes/variables/input.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/variables/input.php [iso-8859-1] Tue Jan 29
12:30:56 2008
@@ -110,6 +110,8 @@
* Executes this node.
*
* @param ezcWorkflowExecution $execution
+ * @return boolean true when the node finished execution,
+ * and false otherwise
* @ignore
*/
public function execute( ezcWorkflowExecution $execution )
@@ -143,6 +145,8 @@
* Generate node configuration from XML representation.
*
* @param DOMElement $element
+ * @return array
+ * @ignore
*/
public static function configurationFromXML( DOMElement $element )
{
@@ -160,6 +164,7 @@
* Generate XML representation of this node's configuration.
*
* @param DOMElement $element
+ * @ignore
*/
public function configurationToXML( DOMElement $element )
{
Modified: trunk/Workflow/src/nodes/variables/mul.php
==============================================================================
--- trunk/Workflow/src/nodes/variables/mul.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/variables/mul.php [iso-8859-1] Tue Jan 29 12:30:56
2008
@@ -44,6 +44,8 @@
* Generate node configuration from XML representation.
*
* @param DOMElement $element
+ * @return array
+ * @ignore
*/
public static function configurationFromXML( DOMElement $element )
{
@@ -57,6 +59,7 @@
* Generate XML representation of this node's configuration.
*
* @param DOMElement $element
+ * @ignore
*/
public function configurationToXML( DOMElement $element )
{
Modified: trunk/Workflow/src/nodes/variables/set.php
==============================================================================
--- trunk/Workflow/src/nodes/variables/set.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/variables/set.php [iso-8859-1] Tue Jan 29 12:30:56
2008
@@ -50,6 +50,8 @@
* configuration.
*
* @param ezcWorkflowExecution $execution
+ * @return boolean true when the node finished execution,
+ * and false otherwise
* @ignore
*/
public function execute( ezcWorkflowExecution $execution )
@@ -68,6 +70,8 @@
* Generate node configuration from XML representation.
*
* @param DOMElement $element
+ * @return array
+ * @ignore
*/
public static function configurationFromXML( DOMElement $element )
{
@@ -85,6 +89,7 @@
* Generate XML representation of this node's configuration.
*
* @param DOMElement $element
+ * @ignore
*/
public function configurationToXML( DOMElement $element )
{
Modified: trunk/Workflow/src/nodes/variables/sub.php
==============================================================================
--- trunk/Workflow/src/nodes/variables/sub.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/variables/sub.php [iso-8859-1] Tue Jan 29 12:30:56
2008
@@ -44,6 +44,8 @@
* Generate node configuration from XML representation.
*
* @param DOMElement $element
+ * @return array
+ * @ignore
*/
public static function configurationFromXML( DOMElement $element )
{
@@ -57,6 +59,7 @@
* Generate XML representation of this node's configuration.
*
* @param DOMElement $element
+ * @ignore
*/
public function configurationToXML( DOMElement $element )
{
Modified: trunk/Workflow/src/nodes/variables/unset.php
==============================================================================
--- trunk/Workflow/src/nodes/variables/unset.php [iso-8859-1] (original)
+++ trunk/Workflow/src/nodes/variables/unset.php [iso-8859-1] Tue Jan 29
12:30:56 2008
@@ -57,6 +57,8 @@
* Executes this node.
*
* @param ezcWorkflowExecution $execution
+ * @return boolean true when the node finished execution,
+ * and false otherwise
* @ignore
*/
public function execute( ezcWorkflowExecution $execution )
@@ -75,6 +77,8 @@
* Generate node configuration from XML representation.
*
* @param DOMElement $element
+ * @return array
+ * @ignore
*/
public static function configurationFromXML( DOMElement $element )
{
@@ -92,6 +96,7 @@
* Generate XML representation of this node's configuration.
*
* @param DOMElement $element
+ * @ignore
*/
public function configurationToXML( DOMElement $element )
{
--
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components
