comment fixes

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

diff --git a/CRM/Core/Selector/API.php b/CRM/Core/Selector/API.php
index cbdd6ed2e9f81180a98e1cc204aa8a471c0f9ce5..382236e82ac124a580485f08df3f9f5fb6561470 100644 (file)
--- a/CRM/Core/Selector/API.php
+++ b/CRM/Core/Selector/API.php
@@ -33,15 +33,14 @@
  * list display, pagination, sorting and export in multiple formats (CSV is
  * supported right now, XML support will be added as and when needed
  *
- *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 interface CRM_Core_Selector_API {
 
   /**
+   * Get pager parameters.
+   *
    * Based on the action, the GET variables and the session state
    * it adds various key => value pairs to the params array including
    *
@@ -55,8 +54,6 @@ interface CRM_Core_Selector_API {
    *   The action being performed.
    * @param array $params
    *   The array that the pagerParams will be inserted into.
-   *
-   * @return void
    */
   public function getPagerParams($action, &$params);
 
@@ -72,7 +69,8 @@ interface CRM_Core_Selector_API {
   public function &getSortOrder($action);
 
   /**
-   * Returns the column headers as an array of tuples:
+   * Returns the column headers as an array of tuples.
+   *
    * (name, sortName (key to the sort array))
    *
    * @param string $action
@@ -116,7 +114,7 @@ interface CRM_Core_Selector_API {
   public function &getRows($action, $offset, $rowCount, $sort, $type = NULL);
 
   /**
-   * Return the template (.tpl) filename
+   * Return the template (.tpl) filename.
    *
    * @param string $action
    *   The action being performed.