comment fixes

[civicrm-core.git] / CRM / Contact / StateMachine / Search.php

diff --git a/CRM/Contact/StateMachine/Search.php b/CRM/Contact/StateMachine/Search.php
index 75f2137c51ff6631d1eec8538fcac0ab88def815..45aee4c3a242c7d53ba1b4605f0d109503169ab6 100644 (file)
--- a/CRM/Contact/StateMachine/Search.php
+++ b/CRM/Contact/StateMachine/Search.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,14 +23,12 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
+ * @copyright CiviCRM LLC (c) 2004-2015
  */
 class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine {
 
@@ -42,8 +40,12 @@ class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine {
   protected $_task;
 
   /**
-   * Class constructor
-   */ function __construct($controller, $action = CRM_Core_Action::NONE) {
+   * Class constructor.
+   *
+   * @param object $controller
+   * @param \const|int $action
+   */
+  public function __construct($controller, $action = CRM_Core_Action::NONE) {
     parent::__construct($controller, $action);
 
     $this->_pages = array();
@@ -85,11 +87,13 @@ class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine {
    * to avoid using  conditional state machine, much more efficient
    * and simpler
    *
-   * @param CRM_Core_Controller $controller the controller object
+   * @param CRM_Core_Controller $controller
+   *   The controller object.
    *
    * @param string $formName
    *
-   * @return string the name of the form that will handle the task
+   * @return string
+   *   the name of the form that will handle the task
    */
   public function taskName($controller, $formName = 'Search') {
     // total hack, check POST vars and then session to determine stuff
@@ -111,7 +115,7 @@ class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine {
   }
 
   /**
-   * Return the form name of the task
+   * Return the form name of the task.
    *
    * @return string
    */
@@ -128,9 +132,9 @@ class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine {
   /**
    * Since this is a state machine for search and we want to come back to the same state
    * we dont want to issue a reset of the state session when we are done processing a task
-   *
    */
   public function shouldReset() {
     return FALSE;
   }
+
 }