INFRA-132 - CRM/Core - Convert single-line @param to multi-line

[civicrm-core.git] / CRM / Core / Selector / Base.php

diff --git a/CRM/Core/Selector/Base.php b/CRM/Core/Selector/Base.php
index 212b0867e9d5a3e30440cdb808f857832036d9bc..e992759f1a542c9d462d8f9f351e7f22bb35b0fd 100644 (file)
--- a/CRM/Core/Selector/Base.php
+++ b/CRM/Core/Selector/Base.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -39,7 +39,7 @@
 class CRM_Core_Selector_Base {
 
   /**
-   * the sort order which is computed from the columnHeaders
+   * The sort order which is computed from the columnHeaders
    *
    * @var array
    */
@@ -63,15 +63,14 @@ class CRM_Core_Selector_Base {
    * This function gets the attribute for the action that
    * it matches.
    *
-   * @param string  match      the action to match against
-   * @param string  attribute  the attribute to return ( name, link, title )
+   * @param string match the action to match against
+   * @param string attribute the attribute to return ( name, link, title )
    *
    * @return string            the attribute that matches the action if any
    *
-   * @access public
    *
    */
-  function getActionAttribute($match, $attribute = 'name') {
+  public function getActionAttribute($match, $attribute = 'name') {
     $links = &$this->links();
 
     foreach ($link as $action => $item) {
@@ -94,31 +93,30 @@ class CRM_Core_Selector_Base {
    * qs      : the parameters to the above url along with any dynamic substitutions
    * title   : A more descriptive name, typically used in breadcrumbs / navigation
    */
-  static function &links() {
+  public static function &links() {
     return NULL;
   }
 
   /**
-   * compose the template file name from the class name
+   * Compose the template file name from the class name
    *
-   * @param string $action the action being performed
+   * @param string $action
+   *   The action being performed.
    *
    * @return string template file name
-   * @access public
    */
-  function getTemplateFileName($action = NULL) {
+  public function getTemplateFileName($action = NULL) {
     return (str_replace('_', DIRECTORY_SEPARATOR, CRM_Utils_System::getClassName($this)) . ".tpl");
   }
 
   /**
-   * getter for the sorting direction for the fields which will be displayed on the form.
+   * Getter for the sorting direction for the fields which will be displayed on the form.
    *
    * @param string action the action being performed
    *
    * @return array the elements that can be sorted along with their properties
-   * @access public
    */
-  function &getSortOrder($action) {
+  public function &getSortOrder($action) {
     $columnHeaders = &$this->getColumnHeaders(NULL);
 
     if (!isset($this->_order)) {
@@ -148,21 +146,19 @@ class CRM_Core_Selector_Base {
   }
 
   /**
-   * setter for permission
+   * Setter for permission
    *
    * @var string
-   * @access public
    */
   public function setPermission($permission) {
     $this->_permission = $permission;
   }
 
   /**
-   * get the display text in plain language for the search
+   * Get the display text in plain language for the search
    * to display on the results page
    *
    * @return string
-   * @access public
    */
   public function getQill() {
     return NULL;
@@ -189,4 +185,3 @@ class CRM_Core_Selector_Base {
     return $this->_key;
   }
 }
-