comment tweaks (typos etc)

diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php
index caac6b3c11e6c76ca259598a3b90fdbf68bf0241..17a48a41795a516069f360560c77874f2fb48ae9 100644 (file)
--- a/CRM/Case/BAO/Case.php
+++ b/CRM/Case/BAO/Case.php
@@ -1369,7 +1369,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
    * @param int $caseID case id
    * @param boolean $skipDetails if true include details of contacts
    *
-   * @return returns $searchRows array of returnproperties
+   * @return array $searchRows array of return properties
    *
    * @static
    */

diff --git a/CRM/Core/BAO/OptionValue.php b/CRM/Core/BAO/OptionValue.php
index 591f61d1f7d5ec6ca66702e1bd65edca4182ddeb..97d572c17eab53e3cd8d841e35875edb729373e2 100644 (file)
--- a/CRM/Core/BAO/OptionValue.php
+++ b/CRM/Core/BAO/OptionValue.php
@@ -168,7 +168,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue {
    * @access public
    * @static
    *
-   * @return object
+   * @return CRM_Core_DAO_OptionValue
    */
   static function add(&$params, &$ids) {
     // CRM-10921: do not reset attributes to default if this is an update

diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php
index 0dd7b0986ea3087c1f9e38c56aa593c7df068047..eda30d9e2e81b07398aa08469a15035d7be78f0c 100644 (file)
--- a/CRM/Core/OptionValue.php
+++ b/CRM/Core/OptionValue.php
@@ -178,7 +178,7 @@ class CRM_Core_OptionValue {
    * @param  integer $optionValueID has the id of the optionValue being edited, disabled ..etc
    *
    * @internal param string $orderBy for orderBy clause
-   * @return array of option-values
+   * @return CRM_Core_DAO_OptionValue
    *
    * @access public
    * @static

diff --git a/api/v3/ActionSchedule.php b/api/v3/ActionSchedule.php
index 1236fa402c2e79d51ee11053d1768c3174161e50..505a849143992637ac65e80da875bbd59438607f 100644 (file)
--- a/api/v3/ActionSchedule.php
+++ b/api/v3/ActionSchedule.php
@@ -79,12 +79,10 @@ function _civicrm_api3_action_schedule_create_spec(&$params) {
 /**
  * delete an existing action_schedule
  *
+ * @param array $params array containing id of the action_schedule
+ * to be deleted
  *
- * @param array $params  (reference) array containing id of the action_schedule
- *                       to be deleted
- *
- * @return array  (referance) returns flag true if successfull, error
- *                message otherwise
+ * @return array API result array
  *
  * @access public
  */

diff --git a/api/v3/Address.php b/api/v3/Address.php
index 2de12df07a40cb9cd083028d917a4d2afaceab5b..9d91da7bfac8aeb8262c3378a5d3626d21b0ca9c 100644 (file)
--- a/api/v3/Address.php
+++ b/api/v3/Address.php
@@ -127,10 +127,10 @@ function _civicrm_api3_address_get_spec(&$params) {
  * {@getfields address_delete}
  * {@example AddressDelete.php 0}
  *
- * @return boolean | error  true if successfull, error otherwise
+ * @return array api result array
  * @access public
  */
-function civicrm_api3_address_delete(&$params) {
+function civicrm_api3_address_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 

diff --git a/api/v3/Contact.php b/api/v3/Contact.php
index 90729ff875a3d30c7337c04490a0a3ecc4654fe7..4ec440ef9b27c2766ff28e20de00a8fb8ff77eea 100644 (file)
--- a/api/v3/Contact.php
+++ b/api/v3/Contact.php
@@ -412,11 +412,10 @@ function _civicrm_api3_contact_update($params, $contactID = NULL) {
 /**
  * Validate the addressee or email or postal greetings
  *
- * @param  $params                   Associative array of property name/value
+ * @param  array $params  Associative array of property name/value
  *                                   pairs to insert in new contact.
  *
  * @throws API_Exception
- * @return array (reference )        null on success, error message otherwise
  *
  * @access public
  */

diff --git a/api/v3/File.php b/api/v3/File.php
index 41086c6ee32ace78fc8e1ec449ec94f705c2e262..2098de66f39f62eb9f598a7b04691b8e277134b5 100644 (file)
--- a/api/v3/File.php
+++ b/api/v3/File.php
@@ -95,14 +95,14 @@ function civicrm_api3_file_get($params) {
  * Update an existing file
  *
  * This api is used for updating an existing file.
- * Required parrmeters : id of a file
+ * Required parameters : id of a file
  *
- * @param  Array   $params  an associative array of name/value property values of civicrm_file
+ * @param  Array   $params an array of name/value property values of civicrm_file
  *
  * @return array of updated file object property values
  * @access public
  */
-function &civicrm_api3_file_update($params) {
+function civicrm_api3_file_update($params) {
 
   if (!isset($params['id'])) {
     return civicrm_api3_create_error('Required parameter missing');

diff --git a/api/v3/Generic.php b/api/v3/Generic.php
index d274ce532121abf8af78aa1754206fc400826a80..f2cb0ea73849463710e6e311f307aa31380faa25 100644 (file)
--- a/api/v3/Generic.php
+++ b/api/v3/Generic.php
@@ -289,7 +289,7 @@ function civicrm_api3_generic_getoptions($apiRequest) {
  * 2) the field is a pseudoconstant and is NOT an FK
  * - the reason for this is that checking / transformation is done on pseudoconstants but
  * - if the field is an FK then mysql will enforce the data quality (& we have handling on failure)
- * @todo - if may be we should define a 'resolve' key on the psuedoconstant for when these rules are not fine enough
+ * @todo - if may be we should define a 'resolve' key on the pseudoconstant for when these rules are not fine enough
  *
  * This function is only split out for the purpose of code clarity / comment block documentation
  *

diff --git a/api/v3/Group.php b/api/v3/Group.php
index 67f39f0d182225d0073e103890907e8eed2c4320..786f15b2d58cb29202dbc2958ca01996e46b2569 100644 (file)
--- a/api/v3/Group.php
+++ b/api/v3/Group.php
@@ -98,11 +98,10 @@ function civicrm_api3_group_get($params) {
  * This method is used to delete any existing group. id of the group
  * to be deleted is required field in $params array
  *
- * @param array $params  (referance) array containing id of the group
+ * @param array $params array containing id of the group
  *                       to be deleted
  *
- * @return array  (referance) returns flag true if successfull, error
- *                message otherwise
+ * @return array API result array
  *@example GroupDelete.php
  *{@getfields group_delete}
  *

diff --git a/api/v3/MailSettings.php b/api/v3/MailSettings.php
index f315f7ed48c6e2bc0b41d96abfa36cb5bd31c6f8..c298312018135e7c6567cea215343a1482d74aa6 100644 (file)
--- a/api/v3/MailSettings.php
+++ b/api/v3/MailSettings.php
@@ -80,11 +80,10 @@ function civicrm_api3_mail_settings_get($params) {
  * This method is used to delete any existing mail_settings. id of the group
  * to be deleted is required field in $params array
  *
- * @param array $params  (reference) array containing id of the group
+ * @param array $params array containing id of the group
  *                       to be deleted
  *
- * @return array  returns flag true if successfull, error
- *                message otherwise
+ * @return array api result array
  * {@getfields mail_settings_delete}
  * @access public
  */

diff --git a/api/v3/MembershipType.php b/api/v3/MembershipType.php
index 315d1b00d7cb2e23fb51306cec65ef23df26133f..8fc6203be219059073e1330e03e44ead0d7522f0 100644 (file)
--- a/api/v3/MembershipType.php
+++ b/api/v3/MembershipType.php
@@ -95,9 +95,9 @@ function civicrm_api3_membership_type_get($params) {
  * Deletes an existing membership type
  *
  * This API is used for deleting a membership type
- * Required parrmeters : id of a membership type
+ * Required parameters : id of a membership type
  *
- * @param  Array   $params  an associative array of name/value property values of civicrm_membership_type
+ * @param  array $params
  *
  * @return boolean        true if success, else false
  * @access public

diff --git a/api/v3/ParticipantPayment.php b/api/v3/ParticipantPayment.php
index bc6be79be3efeecd8ca6737e687c6ef2414aa233..cc9584dc63361acb3353377b684f78c7be854746 100644 (file)
--- a/api/v3/ParticipantPayment.php
+++ b/api/v3/ParticipantPayment.php
@@ -101,7 +101,7 @@ function civicrm_api3_participant_payment_delete($params) {
 
 /**
  * Retrieve one / all contribution(s) / participant(s) linked to a
- * contrbution.
+ * contribution.
  *
  * @param  array   $params  input parameters
  *

diff --git a/api/v3/Phone/Get.php b/api/v3/Phone/Get.php
index 4a9449ab75f0bca81ab892128ccdad72902781ce..d2e323865788e6018ecc9affd2fafffc601cf136 100644 (file)
--- a/api/v3/Phone/Get.php
+++ b/api/v3/Phone/Get.php
@@ -11,7 +11,7 @@
  *
  * @return  array details of found phones else error
  * @access public
- * This function has been declared there instead than in api/v3/Phone.php for no specific reasons, beside to demonstate this feature (that might be useful in your module, eg if you want to implement a civicrm_api ('Phone','Dial') that you would then simply put in your module under api/v3/Phone/Dial.php .
+ * This function has been declared there instead than in api/v3/Phone.php for no specific reasons, beside to demonstrate this feature (that might be useful in your module, eg if you want to implement a civicrm_api ('Phone','Dial') that you would then simply put in your module under api/v3/Phone/Dial.php .
  */
 function civicrm_api3_phone_get($params) {
 

diff --git a/api/v3/Pledge.php b/api/v3/Pledge.php
index 88b55be7d0225b4a2dcae3bb562fd44961eb0c4b..19c7c9bc9ec70771425d52491a61f5c9a39b750c 100644 (file)
--- a/api/v3/Pledge.php
+++ b/api/v3/Pledge.php
@@ -124,9 +124,9 @@ function _civicrm_api3_pledge_create_spec(&$params) {
 /**
  * Retrieve a set of pledges, given a set of input params
  *
- * @param  array   $params           (reference ) input parameters. Use interogate for possible fields
+ * @param  array $params input parameters. Use interrogate for possible fields
  *
- * @return array (reference )        array of pledges, if error an array with an error id and error message
+ * @return array  array of pledges, if error an array with an error id and error message
  * {@getfields pledge_get}
  * @example PledgeGet.php
  * @access public

diff --git a/api/v3/Survey.php b/api/v3/Survey.php
index e049fafda75f5e1a7f94d71bd402d786f7422c0e..ab7b8ca789edcdd56623c53b80c16da8ee84fe6d 100644 (file)
--- a/api/v3/Survey.php
+++ b/api/v3/Survey.php
@@ -81,11 +81,10 @@ function civicrm_api3_survey_get($params) {
  * This method is used to delete any existing survey. id of the group
  * to be deleted is required field in $params array
  *
- * @param array $params  (reference) array containing id of the group
+ * @param array $params array containing id of the group
  *                       to be deleted
  *
- * @return array  (referance) returns flag true if successfull, error
- *                message otherwise
+ * @return array api result array
  * {@getfields survey_delete}
  * @access public
  */

diff --git a/api/v3/examples/Participant/CreateParticipantPayment.php b/api/v3/examples/Participant/CreateParticipantPayment.php
index 6410f870ad04bdbb0c9e1abe60f8a2d125d28c81..19729e30df8feff91962dbc59886087cae368727 100644 (file)
--- a/api/v3/examples/Participant/CreateParticipantPayment.php
+++ b/api/v3/examples/Participant/CreateParticipantPayment.php
@@ -1,7 +1,7 @@
 <?php
 /**
  * Test Generated example of using participant create API
- * single function to create contact w partipation & contribution. Note that in the
+ * single function to create contact w participation & contribution. Note that in the
       case of 'contribution' the 'create' is implied (api.contribution.create) *
  */
 function participant_create_example(){