a few random comment fixes

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

diff --git a/CRM/Activity/StateMachine/Search.php b/CRM/Activity/StateMachine/Search.php
index ad14391ecdb9a711316851283d19fa8360c15d0d..3525c173569a1ad8bcc55bbbaa8b28c5cb940108 100644 (file)
--- a/CRM/Activity/StateMachine/Search.php
+++ b/CRM/Activity/StateMachine/Search.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -37,14 +37,15 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine {
    * The task that the wizard is currently processing
    *
    * @var string
-   * @protected
    */
   protected $_task;
 
   /**
-   * class constructor
+   * Class constructor
+   * @param object $controller
+   * @param \const|int $action
    */
-  function __construct($controller, $action = CRM_Core_Action::NONE) {
+  public function __construct($controller, $action = CRM_Core_Action::NONE) {
     parent::__construct($controller, $action);
 
     $this->_pages = array();
@@ -70,14 +71,15 @@ class CRM_Activity_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
-   * @access protected
+   * @return string
+   *   the name of the form that will handle the task
    */
-  function taskName($controller, $formName = 'Search') {
+  public function taskName($controller, $formName = 'Search') {
     // total hack, check POST vars and then session to determine stuff
     $value = CRM_Utils_Array::value('task', $_POST);
     if (!isset($value)) {
@@ -88,12 +90,11 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine {
   }
 
   /**
-   * return the form name of the task
+   * Return the form name of the task
    *
    * @return string
-   * @access public
    */
-  function getTaskFormName() {
+  public function getTaskFormName() {
     return CRM_Utils_String::getClassName($this->_task);
   }
 
@@ -109,8 +110,7 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine {
   /**
    * @return bool
    */
-  function shouldReset() {
+  public function shouldReset() {
     return FALSE;
   }
 }
-