a few comment fixes

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

diff --git a/CRM/Report/Form/Contact/Summary.php b/CRM/Report/Form/Contact/Summary.php
index c9a02a7ea087f29d8b47f6f3393ae709059119f8..a5e591e2e67cd12836dc9915eb4c6f433a691824 100644 (file)
--- a/CRM/Report/Form/Contact/Summary.php
+++ b/CRM/Report/Form/Contact/Summary.php
@@ -271,8 +271,16 @@ class CRM_Report_Form_Contact_Summary extends CRM_Report_Form {
     $entryFound = TRUE;
   }
 
+  /**
+   * 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;
 
     $genders = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id', array('localize' => TRUE));