Comment fixes

diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contact.php b/CRM/Contact/Form/Search/Custom/FullText/Contact.php
index 834025faeafbd301ab44c09741524c9b333a8bcb..f9290c87673b427511c8c2c859d89eb08df5ac0f 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/FullText/Contact.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Contact.php
@@ -34,6 +34,9 @@
  */
 class CRM_Contact_Form_Search_Custom_FullText_Contact extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
 
+  /**
+   * Class constructor.
+   */
   public function __construct() {
     parent::__construct('Contact', ts('Contacts'));
   }

diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php
index df24428b3a966f3b151700b3a12d8a54b7f015ab..6ef97a21790920874c57db3b1983aeffdebeee01 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php
@@ -34,6 +34,9 @@
  */
 class CRM_Contact_Form_Search_Custom_FullText_Contribution extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
 
+  /**
+   * Class constructor.
+   */
   public function __construct() {
     parent::__construct('Contribution', ts('Contributions'));
   }

diff --git a/CRM/Contact/Form/Search/Custom/FullText/Membership.php b/CRM/Contact/Form/Search/Custom/FullText/Membership.php
index fac21b49fc744526431e3912dfa8994bacf9b5da..aea55a1bbf6a00182b0d4a846f8e10b448e773ff 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/FullText/Membership.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Membership.php
@@ -34,6 +34,9 @@
  */
 class CRM_Contact_Form_Search_Custom_FullText_Membership extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
 
+  /**
+   * Class constructor.
+   */
   public function __construct() {
     parent::__construct('Membership', ts('Memberships'));
   }

diff --git a/CRM/Contact/Form/Search/Custom/FullText/Participant.php b/CRM/Contact/Form/Search/Custom/FullText/Participant.php
index f39dcb67900299c3044ee3eedafb809aec84dbea..7a4503a92453d1419fa0774c714923f1462a7414 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/FullText/Participant.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Participant.php
@@ -34,6 +34,9 @@
  */
 class CRM_Contact_Form_Search_Custom_FullText_Participant extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
 
+  /**
+   * Class constructor.
+   */
   public function __construct() {
     parent::__construct('Participant', ts('Participants'));
   }

diff --git a/CRM/Core/CodeGen/Util/Smarty.php b/CRM/Core/CodeGen/Util/Smarty.php
index fe627988bab1866f9a7899d0544d6c72998c0dfd..ce11d28b3f38ef41573c2dc584f6d5b134e99b61 100644 (file)
--- a/CRM/Core/CodeGen/Util/Smarty.php
+++ b/CRM/Core/CodeGen/Util/Smarty.php
@@ -31,6 +31,11 @@ class CRM_Core_CodeGen_Util_Smarty {
     }
   }
 
+  /**
+   * Set plugin directories.
+   *
+   * @param array $pluginDirs
+   */
   public function setPluginDirs($pluginDirs) {
     $this->smartyPluginDirs = $pluginDirs;
     $this->smarty = NULL;

diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php
index 1a7035aacae298b66b9bc49b855bdb5021890a74..cbe49b178cdf0f13c7edcd6812cdf3be4742daea 100644 (file)
--- a/CRM/Core/Form.php
+++ b/CRM/Core/Form.php
@@ -152,7 +152,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
   private $_chainSelectFields = array();
 
   /**
-   * Constructor for the basic form page
+   * Constructor for the basic form page.
    *
    * We should not use QuickForm directly. This class provides a lot
    * of default convenient functions, rules and buttons
@@ -361,7 +361,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
   }
 
   /**
-   * The postProcess hook is typically called by the framework
+   * The postProcess hook is typically called by the framework.
    * However in a few cases, the form exits or redirects early in which
    * case it needs to call this function so other modules can do the needful
    * Calling this function directly should be avoided if possible. In general a

diff --git a/CRM/Core/I18n/SchemaStructure_4_5_beta2.php b/CRM/Core/I18n/SchemaStructure_4_5_beta2.php
index 50aab894e6e5fe29ed8fac3962073a63c4b50d49..8131ac8d142b66e68465255621895df1511b05e2 100644 (file)
--- a/CRM/Core/I18n/SchemaStructure_4_5_beta2.php
+++ b/CRM/Core/I18n/SchemaStructure_4_5_beta2.php
@@ -34,6 +34,10 @@
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  */
 class CRM_Core_I18n_SchemaStructure_4_5_beta2 {
+
+  /**
+   * Get column definition.
+   */
   public static function &columns() {
     static $result = NULL;
     if (!$result) {

diff --git a/CRM/Core/ManagedEntities.php b/CRM/Core/ManagedEntities.php
index e47c7dfde2ea8133cf5283b5e4b1dd7d70863fa6..16ac0ad2fd3fe8d305255ad6abf118e29a575d08 100644 (file)
--- a/CRM/Core/ManagedEntities.php
+++ b/CRM/Core/ManagedEntities.php
@@ -7,6 +7,11 @@
  */
 class CRM_Core_ManagedEntities {
 
+  /**
+   * Get clean up options.
+   *
+   * @return array
+   */
   public static function getCleanupOptions() {
     return array(
       'always' => ts('Always'),

diff --git a/CRM/Core/Page/Redirect.php b/CRM/Core/Page/Redirect.php
index f5f484e708ec0cd1b5ef78c6da3ff2c2cf8362bf..4498ecd0cd1a17f22da9ae2b69ea3e57c5d07c26 100644 (file)
--- a/CRM/Core/Page/Redirect.php
+++ b/CRM/Core/Page/Redirect.php
@@ -12,6 +12,15 @@
  * @endcoe
  */
 class CRM_Core_Page_Redirect extends CRM_Core_Page {
+
+  /**
+   * Run page
+   *
+   * @param string $path
+   * @param array $pageArgs
+   *
+   * @return string|void
+   */
   public function run($path = NULL, $pageArgs = array()) {
     $url = self::createUrl($path, $_REQUEST, $pageArgs, TRUE);
     // return $url;

diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php
index 9314b1f1f06f02d636a65d091e6c409675532911..d01df5c4ef115083ecf26ad3b322fbc0af830c10 100644 (file)
--- a/CRM/Report/Form.php
+++ b/CRM/Report/Form.php
@@ -1766,10 +1766,15 @@ class CRM_Report_Form extends CRM_Core_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
   }
 
   /**

diff --git a/CRM/Report/Form/Activity.php b/CRM/Report/Form/Activity.php
index bd7ca05529afacaebdcfc7b243557460359b89ae..721c0274b0fe2755dd61ed402f98cee9ba6b19bb 100644 (file)
--- a/CRM/Report/Form/Activity.php
+++ b/CRM/Report/Form/Activity.php
@@ -767,16 +767,19 @@ GROUP BY civicrm_activity_id {$this->_having} {$this->_orderBy} {$this->_limit}"
   }
 
   /**
-   * @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;
     $activityType = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
     $activityStatus = CRM_Core_PseudoConstant::activityStatus();
     $viewLinks = FALSE;
-    $seperator = CRM_Core_DAO::VALUE_SEPARATOR;
     $context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'report');
     $actUrl = '';
 

diff --git a/CRM/Report/Form/ActivitySummary.php b/CRM/Report/Form/ActivitySummary.php
index cb57d817fe85e35c6767f5ab2b0d375b3df31700..392305bb3049d68b8ed2e6268d434f6a5d99d5ec 100644 (file)
--- a/CRM/Report/Form/ActivitySummary.php
+++ b/CRM/Report/Form/ActivitySummary.php
@@ -458,10 +458,15 @@ class CRM_Report_Form_ActivitySummary 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;
     $activityType = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE);

diff --git a/CRM/Report/Form/Campaign/SurveyDetails.php b/CRM/Report/Form/Campaign/SurveyDetails.php
index 248f8c3582fff899168d4fdadc481560a4d6f398..078647aa1fcb4e5ce81982b132207e1c35836d40 100644 (file)
--- a/CRM/Report/Form/Campaign/SurveyDetails.php
+++ b/CRM/Report/Form/Campaign/SurveyDetails.php
@@ -608,17 +608,19 @@ INNER JOIN  civicrm_option_value val ON ( val.option_group_id = survey.result_id
   }
 
   /**
-   * @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) {
 
-    //format the survey result data.
     $this->_formatSurveyResult($rows);
-
-    //format the survey response data.
     $this->_formatSurveyResponseData($rows);
 
-    // custom code to alter rows
     $entryFound = FALSE;
     foreach ($rows as $rowNum => $row) {
       // handle state province

diff --git a/CRM/Report/Form/Case/Demographics.php b/CRM/Report/Form/Case/Demographics.php
index 7a5c02cc4880d95030e06a1926061cc8a4171302..b50ed04ae739241e0a16a4b145bfab269cbcdf63 100644 (file)
--- a/CRM/Report/Form/Case/Demographics.php
+++ b/CRM/Report/Form/Case/Demographics.php
@@ -378,10 +378,15 @@ where (cg.extends='Contact' OR cg.extends='Individual' OR cg.extends_entity_colu
   }
 
   /**
-   * @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

diff --git a/CRM/Report/Form/Case/Detail.php b/CRM/Report/Form/Case/Detail.php
index 25722bb239d4b143e65ec3ffcf5200047f1a52ae..2cd970144a75827e9a59ead3e4882ff906c95a09 100644 (file)
--- a/CRM/Report/Form/Case/Detail.php
+++ b/CRM/Report/Form/Case/Detail.php
@@ -572,7 +572,13 @@ class CRM_Report_Form_Case_Detail 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) {
     $entryFound = FALSE;

diff --git a/CRM/Report/Form/Case/Summary.php b/CRM/Report/Form/Case/Summary.php
index eaf22ce8a445c588978bd5eacf4518e44025639f..762b689884cdcde288d8ff2592b7dd1d03f23c66 100644 (file)
--- a/CRM/Report/Form/Case/Summary.php
+++ b/CRM/Report/Form/Case/Summary.php
@@ -341,7 +341,13 @@ inner join civicrm_contact $c2 on ${c2}.id=${ccc}.contact_id
   }
 
   /**
-   * @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) {
     $entryFound = FALSE;