a few comment fixes

[civicrm-core.git] / CRM / Report / Form / Mailing / Summary.php

diff --git a/CRM/Report/Form/Mailing/Summary.php b/CRM/Report/Form/Mailing/Summary.php
index a604330a9fc4f94714cdde26b5131dbef8073c50..82d5381e0fc47c756c5c9400cd1d14a129f3f1e5 100644 (file)
--- a/CRM/Report/Form/Mailing/Summary.php
+++ b/CRM/Report/Form/Mailing/Summary.php
@@ -571,10 +571,15 @@ class CRM_Report_Form_Mailing_Summary extends CRM_Report_Form {
   }
 
   /**
-   * @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;
     foreach ($rows as $rowNum => $row) {
       // make count columns point to detail report