From 7c285037c9ebd5ed369a7cdf768ca08f04f8385e Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Sat, 24 May 2014 16:33:15 +1200 Subject: [PATCH] comment tweaks (typos etc) --- CRM/Case/BAO/Case.php | 2 +- CRM/Core/BAO/OptionValue.php | 2 +- CRM/Core/OptionValue.php | 2 +- api/v3/ActionSchedule.php | 8 +++----- api/v3/Address.php | 4 ++-- api/v3/Contact.php | 3 +-- api/v3/File.php | 6 +++--- api/v3/Generic.php | 2 +- api/v3/Group.php | 5 ++--- api/v3/MailSettings.php | 5 ++--- api/v3/MembershipType.php | 4 ++-- api/v3/ParticipantPayment.php | 2 +- api/v3/Phone/Get.php | 2 +- api/v3/Pledge.php | 4 ++-- api/v3/Survey.php | 5 ++--- api/v3/examples/Participant/CreateParticipantPayment.php | 2 +- 16 files changed, 26 insertions(+), 32 deletions(-) diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index caac6b3c11..17a48a4179 100644 --- 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 591f61d1f7..97d572c17e 100644 --- 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 0dd7b0986e..eda30d9e2e 100644 --- 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 1236fa402c..505a849143 100644 --- 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 2de12df07a..9d91da7bfa 100644 --- 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 90729ff875..4ec440ef9b 100644 --- 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 41086c6ee3..2098de66f3 100644 --- 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 d274ce5321..f2cb0ea738 100644 --- 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 67f39f0d18..786f15b2d5 100644 --- 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 f315f7ed48..c298312018 100644 --- 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 315d1b00d7..8fc6203be2 100644 --- 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 bc6be79be3..cc9584dc63 100644 --- 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 4a9449ab75..d2e3238657 100644 --- 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 88b55be7d0..19c7c9bc9e 100644 --- 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 e049fafda7..ab7b8ca789 100644 --- 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 6410f870ad..19729e30df 100644 --- a/api/v3/examples/Participant/CreateParticipantPayment.php +++ b/api/v3/examples/Participant/CreateParticipantPayment.php @@ -1,7 +1,7 @@