Merge remote-tracking branch 'upstream/4.5' into 4.5-master-2014-12-22-22-01-44

[civicrm-core.git] / CRM / Core / State.php

diff --git a/CRM/Core/State.php b/CRM/Core/State.php
index 5f65d674b8d477c9ac0d4b1a769ce6549d0c4d01..fbd30317143a7407b49651a4cbdb3796ed006fe4 100644 (file)
--- a/CRM/Core/State.php
+++ b/CRM/Core/State.php
@@ -39,32 +39,32 @@
 class CRM_Core_State {
 
   /**
-   * state name
+   * State name
    * @var string
    */
   protected $_name;
 
   /**
-   * this is a combination "OR" of the STATE_* constants defined below
+   * This is a combination "OR" of the STATE_* constants defined below
    * @var int
    */
   protected $_type;
 
   /**
-   * the state that precedes this state
-   * @var object
+   * The state that precedes this state
+   * @var CRM_Core_State
    */
   protected $_back;
 
   /**
-   * the state that succeeds this state
-   * @var object
+   * The state that succeeds this state
+   * @var CRM_Core_State
    */
   protected $_next;
 
   /**
    * The state machine that this state is part of
-   * @var object
+   * @var CRM_Core_StateMachine
    */
   protected $_stateMachine;
 
@@ -77,15 +77,15 @@ class CRM_Core_State {
   CONST START = 1, FINISH = 2, SIMPLE = 4;
 
   /**
-   * constructor
+   * Constructor
    *
-   * @param string the internal name of the state
-   * @param int    the state type
-   * @param object the state that precedes this state
-   * @param object the state that follows  this state
-   * @param object the statemachine that this states belongs to
+   * @param string $name internal name of the state
+   * @param int $type state type
+   * @param CRM_Core_State $back state that precedes this state
+   * @param CRM_Core_State $next state that follows  this state
+   * @param CRM_Core_StateMachine $stateMachine statemachine that this states belongs to
    *
-   * @return object
+   * @return CRM_Core_State
    * @access public
    */
   function __construct($name, $type, $back, $next, &$stateMachine) {
@@ -181,7 +181,7 @@ class CRM_Core_State {
   }
 
   /**
-   * getter for name
+   * Getter for name
    *
    * @return string
    * @access public
@@ -191,7 +191,7 @@ class CRM_Core_State {
   }
 
   /**
-   * setter for name
+   * Setter for name
    *
    * @param string
    *
@@ -203,7 +203,7 @@ class CRM_Core_State {
   }
 
   /**
-   * getter for type
+   * Getter for type
    *
    * @return int
    * @access public