fixes to comment blocks & spelling

diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php
index 38976d9353ddc1ac7200d861aaf4139b25826644..7a6101f0ce43aaafd9baca020b060e4a811de527 100644 (file)
--- a/CRM/Report/Form.php
+++ b/CRM/Report/Form.php
@@ -2253,6 +2253,9 @@ WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND
     }
   }
 
+  /**
+   * Post Processing function for Form (postProcessCommon should be used to set other variables from input as the api accesses that function)
+   */
   function beginPostProcess() {
     $this->setParams($this->controller->exportValues($this->_name));
 

diff --git a/CRM/Report/Form/Contribute/OrganizationSummary.php b/CRM/Report/Form/Contribute/OrganizationSummary.php
index 160345197e5f3463078358c7a2e8516127a2cde6..2bd2396bda9f4e66880abcf5254bbff52eab179f 100644 (file)
--- a/CRM/Report/Form/Contribute/OrganizationSummary.php
+++ b/CRM/Report/Form/Contribute/OrganizationSummary.php
@@ -413,7 +413,7 @@ class CRM_Report_Form_Contribute_OrganizationSummary extends CRM_Report_Form {
   }
 
   /**
-   * @param $rows
+   * @param array $rows
    */
   function alterDisplay(&$rows) {
     // custom code to alter rows

diff --git a/api/v3/Case.php b/api/v3/Case.php
index a19d0f7d0920d4ebbb122d8607f72323fd0ec368..f19ee9c64928c00c9691df719a575b4073e3d8fc 100644 (file)
--- a/api/v3/Case.php
+++ b/api/v3/Case.php
@@ -266,6 +266,11 @@ SELECT DISTINCT case_id
 
 /**
  * Deprecated. Use activity API instead
+ *
+ * @param array $params
+ *
+ * @throws API_Exception
+ * @return array
  */
 function civicrm_api3_case_activity_create($params) {
   return civicrm_api3_activity_create($params);
@@ -415,6 +420,8 @@ function _civicrm_api3_case_read($caseId, $options) {
 
 /**
  * Internal function to format create params for processing
+ *
+ * @param array $params
  */
 function _civicrm_api3_case_format_params(&$params) {
   // figure out case type id from case type and vice-versa

diff --git a/api/v3/Generic/Setvalue.php b/api/v3/Generic/Setvalue.php
index ff3e6011873f3eb15d67bf990da33fd934294b30..bb1055259dbbb8a6191830ce522589d2c3a9b464 100644 (file)
--- a/api/v3/Generic/Setvalue.php
+++ b/api/v3/Generic/Setvalue.php
@@ -1,6 +1,11 @@
 <?php
 /**
  * params must contain at least id=xx & {one of the fields from getfields}=value
+ *
+ * @param $apiRequest
+ *
+ * @throws API_Exception
+ * @return array
  */
 function civicrm_api3_generic_setValue($apiRequest) {
   $entity = $apiRequest['entity'];

diff --git a/api/v3/Generic/Update.php b/api/v3/Generic/Update.php
index 68e4fe5e66e7aa7731191394dc76ff9845c5d21c..258478e26ec479e3c0aed9c1d20b25efd35bd7be 100644 (file)
--- a/api/v3/Generic/Update.php
+++ b/api/v3/Generic/Update.php
@@ -35,7 +35,7 @@
  * To do this, perform a 'get' action to load the existing values, then merge in the updates
  * and call 'create' to save the revised entity.
  *
- * @param $apiRequest an array with keys:
+ * @param array $apiRequest array with keys:
  *  - entity: string
  *  - action: string
  *  - version: string
@@ -72,4 +72,3 @@ function civicrm_api3_generic_update($apiRequest) {
   $p = array_merge($existing, $apiRequest['params']);
   return civicrm_api($apiRequest['entity'], 'create', $p);
 }
-

diff --git a/api/v3/Job.php b/api/v3/Job.php
index fefc2181dfdd5be4d39b72262eb1d43802bc9f73..9ff7795cc9f1cf8b3aefe6d7537a51a7b20c9ec3 100644 (file)
--- a/api/v3/Job.php
+++ b/api/v3/Job.php
@@ -83,9 +83,7 @@ function civicrm_api3_job_get($params) {
 /**
  * Delete a job
  *
- * @param $params
- *
- * @internal param int $id
+ * @param array $params
  *
  * @return array API Result Array
  * {@getfields Job_delete}
@@ -100,7 +98,7 @@ function civicrm_api3_job_delete($params) {
  * Dumb wrapper to execute scheduled jobs. Always creates success - errors
  * and results are handled in the job log.
  *
- * @param  array       $params (reference ) input parameters
+ * @param  array $params (reference ) input parameters
  *
  * @return array API Result Array
  *
@@ -150,8 +148,11 @@ function civicrm_api3_job_geocode($params) {
     return civicrm_api3_create_error($result['messages']);
   }
 }
+
 /**
  * First check on Code documentation
+ *
+ * @param array $params
  */
 function _civicrm_api3_job_geocode_spec(&$params) {
   $params['start'] = array('title' => 'Start Date');
@@ -241,7 +242,7 @@ function civicrm_api3_job_mail_report($params) {
  *
  *                        id - Integer - greetings option group
  *
- * @param $params
+ * @param array $params
  *
  * @return boolean        true if success, else false
  * @static
@@ -356,6 +357,10 @@ function civicrm_api3_job_process_sms($params) {
 
 /**
  * Job to get mail responses from civimailing
+ *
+ * @param array $params
+ *
+ * @return array
  */
 function civicrm_api3_job_fetch_bounces($params) {
   $lock = new CRM_Core_Lock('civimail.job.EmailProcessor');
@@ -375,6 +380,10 @@ function civicrm_api3_job_fetch_bounces($params) {
 
 /**
  * Job to get mail and create activities
+ *
+ * @param array $params
+ *
+ * @return array
  */
 function civicrm_api3_job_fetch_activities($params) {
   $lock = new CRM_Core_Lock('civimail.job.EmailProcessor');
@@ -569,6 +578,9 @@ function civicrm_api3_job_cleanup( $params ) {
 /**
  * Set expired relationships to disabled.
  *
+ * @param array $params
+ *
+ * @return array
  */
 function civicrm_api3_job_disable_expired_relationships($params) {
   $result = CRM_Contact_BAO_Relationship::disableExpiredRelationships();
@@ -585,8 +597,12 @@ function civicrm_api3_job_disable_expired_relationships($params) {
  * it is recommended that they use the limit clause to limit the number of smart groups
  * evaluated on a per job basis. Might also help to increase the smartGroupCacheTimeout
  * and use the cache
+ *
+ * @param array $params
+ *
+ * @return array
  */
-function civicrm_api3_job_group_rebuild( $params ) {
+function civicrm_api3_job_group_rebuild($params) {
   $lock = new CRM_Core_Lock('civimail.job.groupRebuild');
   if (!$lock->isAcquired()) {
     return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');

diff --git a/api/v3/Profile.php b/api/v3/Profile.php
index 08a1914d5e6a2951187d05f3ea804412f7e8bf3b..04eb4314571e3d32ef296733ed39ab6eeedd00fd 100644 (file)
--- a/api/v3/Profile.php
+++ b/api/v3/Profile.php
@@ -693,7 +693,7 @@ function _civicrm_api3_map_profile_fields_to_entity(&$field) {
  *
  * @param $profileID
  *
- * @return array
+ * @return integer|string
  * @throws CiviCRM_API3_Exception
  */
 function _civicrm_api3_profile_getProfileID($profileID) {

diff --git a/api/v3/Tag.php b/api/v3/Tag.php
index 2189159e435012d16ee9a63e49f1eef2d9411062..92415babb443ffd5d8721cf24e7ef24dafb21b46 100644 (file)
--- a/api/v3/Tag.php
+++ b/api/v3/Tag.php
@@ -55,6 +55,8 @@ function civicrm_api3_tag_create($params) {
 /**
  * Specify Meta data for create. Note that this data is retrievable via the getfields function
  * and is used for pre-filling defaults and ensuring mandatory requirements are met.
+ *
+ * @param array $params
  */
 function _civicrm_api3_tag_create_spec(&$params) {
   $params['used_for']['api.default'] = 'civicrm_contact';

diff --git a/api/v3/examples/Group/getfields.php b/api/v3/examples/Group/getfields.php
index 490f2c7f0a83e772eb36cee0efa7689fa9238de5..c601bd49e133509bbcdb23e00a3255288157a003 100644 (file)
--- a/api/v3/examples/Group/getfields.php
+++ b/api/v3/examples/Group/getfields.php
@@ -1,7 +1,7 @@
 <?php
 /**
  * Test Generated example of using group getfields API
- * demonstrate use of getfields to interogate api *
+ * demonstrate use of getfields to interrogate api *
  */
 function group_getfields_example(){
 $params = array(

diff --git a/api/v3/examples/Tag/Getfields.php b/api/v3/examples/Tag/Getfields.php
index 1eda5003720bdb2995d6270201a23ce40eac80ef..6c7f9d2e7ac032d5de368be7cd817df07461228e 100644 (file)
--- a/api/v3/examples/Tag/Getfields.php
+++ b/api/v3/examples/Tag/Getfields.php
@@ -1,7 +1,7 @@
 <?php
 /**
  * Test Generated example of using tag getfields API
- * demonstrate use of getfields to interogate api *
+ * demonstrate use of getfields to interrogate api *
  */
 function tag_getfields_example(){
 $params = array(

diff --git a/tests/phpunit/api/v3/EventTest.php b/tests/phpunit/api/v3/EventTest.php
index 1769fc7f637ff86695690a5a8799b507e93f1779..554574ad4b21c7f6401da6a743e676f111feed7a 100644 (file)
--- a/tests/phpunit/api/v3/EventTest.php
+++ b/tests/phpunit/api/v3/EventTest.php
@@ -500,7 +500,7 @@ class api_v3_EventTest extends CiviUnitTestCase {
   }
 
   function testgetfields() {
-    $description = "demonstrate use of getfields to interogate api";
+    $description = "demonstrate use of getfields to interrogate api";
     $params = array('action' => 'create');
     $result = $this->callAPISuccess('event', 'getfields', $params);
     $this->assertEquals(1, $result['values']['title']['api.required'], 'in line ' . __LINE__);
@@ -509,19 +509,19 @@ class api_v3_EventTest extends CiviUnitTestCase {
      * test api_action param also works
      */
   function testgetfieldsRest() {
-    $description = "demonstrate use of getfields to interogate api";
+    $description = "demonstrate use of getfields to interrogate api";
     $params = array('api_action' => 'create');
     $result = $this->callAPISuccess('event', 'getfields', $params);
     $this->assertEquals(1, $result['values']['title']['api.required'], 'in line ' . __LINE__);
   }
   function testgetfieldsGet() {
-    $description = "demonstrate use of getfields to interogate api";
+    $description = "demonstrate use of getfields to interrogate api";
     $params = array('action' => 'get');
     $result = $this->callAPISuccess('event', 'getfields', $params);
     $this->assertEquals('title', $result['values']['event_title']['name'], 'in line ' . __LINE__);
   }
   function testgetfieldsDelete() {
-    $description = "demonstrate use of getfields to interogate api";
+    $description = "demonstrate use of getfields to interrogate api";
     $params = array('action' => 'delete');
     $result = $this->callAPISuccess('event', 'getfields', $params);
     $this->assertEquals(1, $result['values']['id']['api.required']);

diff --git a/tests/phpunit/api/v3/GroupTest.php b/tests/phpunit/api/v3/GroupTest.php
index 6def8b7ff9ece8ff18a5ab6f095553d35a3d57af..e808bc4d0aa5b4c23ad93f1fc94ca9df59e96607 100644 (file)
--- a/tests/phpunit/api/v3/GroupTest.php
+++ b/tests/phpunit/api/v3/GroupTest.php
@@ -152,7 +152,7 @@ class api_v3_GroupTest extends CiviUnitTestCase {
   }
 
   function testgetfields() {
-    $description = "demonstrate use of getfields to interogate api";
+    $description = "demonstrate use of getfields to interrogate api";
     $params = array('action' => 'create');
     $result = $this->callAPIAndDocument('group', 'getfields', $params, __FUNCTION__, __FILE__, $description, 'getfields', 'getfields');
     $this->assertEquals(1, $result['values']['is_active']['api.default']);

diff --git a/tests/phpunit/api/v3/TagTest.php b/tests/phpunit/api/v3/TagTest.php
index 6d2685ce2e586a67461085ce3e90f522390eb561..24d531a93e55dfa2842f95b3dbdc840ce8dd68bb 100644 (file)
--- a/tests/phpunit/api/v3/TagTest.php
+++ b/tests/phpunit/api/v3/TagTest.php
@@ -186,7 +186,7 @@ class api_v3_TagTest extends CiviUnitTestCase {
   }
 
   function testTagGetfields() {
-    $description = "demonstrate use of getfields to interogate api";
+    $description = "demonstrate use of getfields to interrogate api";
     $params      = array('action' => 'create');
     $result      = $this->callAPIAndDocument('tag', 'getfields', $params, __FUNCTION__, __FILE__, $description, NULL, 'getfields');
     $this->assertEquals('civicrm_contact', $result['values']['used_for']['api.default']);