a few comment fixes

[civicrm-core.git] / CRM / Report / Form / Contribute / TopDonor.php

diff --git a/CRM/Report/Form/Contribute/TopDonor.php b/CRM/Report/Form/Contribute/TopDonor.php
index 3c93823395c0bbcc08bea13c1521b73317e37e12..fdb055fdc89df2f2015bd060336e5a067e1accae 100644 (file)
--- a/CRM/Report/Form/Contribute/TopDonor.php
+++ b/CRM/Report/Form/Contribute/TopDonor.php
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -417,11 +417,15 @@ ORDER BY civicrm_contribution_total_amount_sum DESC
   }
 
   /**
-   * @param $rows
+   * Alter display of rows.
+   *
+   * Iterate through the rows retrieved via SQL and make changes for display purposes,
+   * such as rendering contacts as links.
+   *
+   * @param array $rows
+   *   Rows generated by SQL, with an array for each row.
    */
   public function alterDisplay(&$rows) {
-    // custom code to alter rows
-
     $entryFound = FALSE;
     $rank = 1;
     if (!empty($rows)) {
@@ -451,4 +455,5 @@ ORDER BY civicrm_contribution_total_amount_sum DESC
       }
     }
   }
+
 }