Cleanup phpdoc comments

[civicrm-core.git] / CRM / Utils / Pager.php

diff --git a/CRM/Utils/Pager.php b/CRM/Utils/Pager.php
index 9615cccdcca9f94a5893c51d96d9aa11c0ea0527..feab68279a7c86bd8b63de3e6782af6abf979ee3 100644 (file)
--- a/CRM/Utils/Pager.php
+++ b/CRM/Utils/Pager.php
@@ -51,12 +51,12 @@ require_once 'Pager/Sliding.php';
 class CRM_Utils_Pager extends Pager_Sliding {
 
   /**
-   * constants for static parameters of the pager
+   * Constants for static parameters of the pager
    */
   CONST ROWCOUNT = 50, PAGE_ID = 'crmPID', PAGE_ID_TOP = 'crmPID', PAGE_ID_BOTTOM = 'crmPID_B', PAGE_ROWCOUNT = 'crmRowCount';
 
   /**
-   * the output of the pager. This is a name/value array with various keys
+   * The output of the pager. This is a name/value array with various keys
    * that an application could use to display the pager
    * @var array
    */
@@ -68,7 +68,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
    * We have embedded some html in this class. Need to figure out how to export this
    * to the top level at some point in time
    *
-   * @param $params
+   * @param array $params
    *
    * @internal param \total $int the total count of items to be displayed
    * @internal param \currentPage $int the page currently being displayed
@@ -129,7 +129,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
   }
 
   /**
-   * helper function to assign remaining pager options as good default
+   * Helper function to assign remaining pager options as good default
    * values
    *
    * @param array   $params      the set of options needed to initialize the parent
@@ -192,7 +192,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
    *
    * @param int $defaultPageId defaultPageId   current pageId
    *
-   * @param $params
+   * @param array $params
    *
    * @return int                new pageId to display to the user
    * @access public