From db95eff68635224f493784698a07038c09ca1233 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:09 -0800 Subject: [PATCH] INFRA-132 - CRM/PCP - Convert single-line @param to multi-line --- CRM/PCP/BAO/PCP.php | 41 ++++++++++++++++++++++++------------- CRM/PCP/Form/Campaign.php | 6 ++++-- CRM/PCP/Form/Contribute.php | 3 ++- CRM/PCP/Form/Event.php | 3 ++- CRM/PCP/Form/PCP.php | 3 ++- CRM/PCP/Form/PCPAccount.php | 6 ++++-- 6 files changed, 41 insertions(+), 21 deletions(-) diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php index b3aeb072de..b03aa3ee6f 100644 --- a/CRM/PCP/BAO/PCP.php +++ b/CRM/PCP/BAO/PCP.php @@ -52,8 +52,10 @@ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP { /** * Add or update either a Personal Campaign Page OR a PCP Block * - * @param array $params reference array contains the values submitted by the form - * @param bool $pcpBlock if true, create or update PCPBlock, else PCP + * @param array $params + * Reference array contains the values submitted by the form. + * @param bool $pcpBlock + * If true, create or update PCPBlock, else PCP. * * @static * @@ -90,7 +92,8 @@ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP { /** * Get the Display name of a contact for a PCP * - * @param int $id id for the PCP + * @param int $id + * Id for the PCP. * * @return null|string Dispaly name of the contact if found * @static @@ -228,7 +231,8 @@ ORDER BY target_entity_type, target_entity_id /** * Show the total amount for Personal Campaign Page on thermometer * - * @param array $pcpId contains the pcp ID + * @param array $pcpId + * Contains the pcp ID. * * @static * @@ -249,7 +253,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Show the amount, nickname on honor roll * - * @param array $pcpId contains the pcp ID + * @param array $pcpId + * Contains the pcp ID. * * @static * @@ -346,7 +351,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Delete the campaign page * - * @param int $id campaign page id + * @param int $id + * Campaign page id. * * @return null * @static @@ -370,7 +376,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Build the form object * - * @param CRM_Core_Form $form form object + * @param CRM_Core_Form $form + * Form object. * * @return void */ @@ -423,7 +430,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; * Add PCP form elements to a form */ /** - * @param integer $pcpId + * @param int $pcpId * @param CRM_Core_Page $page * @param null $elements */ @@ -578,7 +585,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Approve / Reject the campaign page * - * @param int $id campaign page id + * @param int $id + * Campaign page id. * * @param $is_active * @@ -622,8 +630,10 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; * 1. when their PCP status is changed by site admin. * 2. when supporter initially creates a Personal Campaign Page ($isInitial set to true). * - * @param int $pcpId campaign page id - * @param int $newStatus pcp status id + * @param int $pcpId + * Campaign page id. + * @param int $newStatus + * Pcp status id. * @param bool|int $isInitial is it the first time, campaign page has been created by the user * * @param string $component @@ -718,7 +728,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Enable / Disable the campaign page * - * @param int $id campaign page id + * @param int $id + * Campaign page id. * * @param $is_active * @return null @@ -777,7 +788,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Find out if the PCP block is in use by one or more PCP page * - * @param int $id pcp block id + * @param int $id + * Pcp block id. * * @return Boolean * @static @@ -797,7 +809,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; /** * Get email is enabled for supporter's profile * - * @param int $profileId supporter's profile id + * @param int $profileId + * Supporter's profile id. * * @return boolean * @static diff --git a/CRM/PCP/Form/Campaign.php b/CRM/PCP/Form/Campaign.php index 846fbe31af..21b9fd14bb 100644 --- a/CRM/PCP/Form/Campaign.php +++ b/CRM/PCP/Form/Campaign.php @@ -148,8 +148,10 @@ class CRM_PCP_Form_Campaign extends CRM_Core_Form { /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param $self * * diff --git a/CRM/PCP/Form/Contribute.php b/CRM/PCP/Form/Contribute.php index e0eb4e9384..31961bad6e 100644 --- a/CRM/PCP/Form/Contribute.php +++ b/CRM/PCP/Form/Contribute.php @@ -99,7 +99,8 @@ class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage { /** * Validation * - * @param array $params (ref.) an assoc array of name/value pairs + * @param array $params + * (ref.) an assoc array of name/value pairs. * * @param $files * @param $self diff --git a/CRM/PCP/Form/Event.php b/CRM/PCP/Form/Event.php index 10bc646d4d..02ead9c237 100644 --- a/CRM/PCP/Form/Event.php +++ b/CRM/PCP/Form/Event.php @@ -130,7 +130,8 @@ class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent { /** * Validation * - * @param array $params (ref.) an assoc array of name/value pairs + * @param array $params + * (ref.) an assoc array of name/value pairs. * * @param $files * @param $self diff --git a/CRM/PCP/Form/PCP.php b/CRM/PCP/Form/PCP.php index e089d44f7e..bafc8bc570 100644 --- a/CRM/PCP/Form/PCP.php +++ b/CRM/PCP/Form/PCP.php @@ -189,7 +189,8 @@ class CRM_PCP_Form_PCP extends CRM_Core_Form { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @param $files * @param CRM_Core_Form $form diff --git a/CRM/PCP/Form/PCPAccount.php b/CRM/PCP/Form/PCPAccount.php index c82b8b075d..49744abe39 100644 --- a/CRM/PCP/Form/PCPAccount.php +++ b/CRM/PCP/Form/PCPAccount.php @@ -222,8 +222,10 @@ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param $self * * -- 2.25.1