From c4ca4892398c0efed55db2a91bcf44a31df78237 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:07 -0800 Subject: [PATCH] INFRA-132 - CRM/Custom - Convert single-line @param to multi-line --- CRM/Custom/Form/Field.php | 3 ++- CRM/Custom/Form/Group.php | 9 ++++++--- CRM/Custom/Form/Option.php | 3 ++- CRM/Custom/Import/Form/MapField.php | 3 ++- CRM/Custom/Import/Parser/Api.php | 18 ++++++++++++------ CRM/Custom/Page/Field.php | 6 ++++-- CRM/Custom/Page/Group.php | 12 ++++++++---- CRM/Custom/Page/Option.php | 3 ++- 8 files changed, 38 insertions(+), 19 deletions(-) diff --git a/CRM/Custom/Form/Field.php b/CRM/Custom/Form/Field.php index 925463294e..0af9ef704d 100644 --- a/CRM/Custom/Form/Field.php +++ b/CRM/Custom/Form/Field.php @@ -555,7 +555,8 @@ class CRM_Custom_Form_Field 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 $self diff --git a/CRM/Custom/Form/Group.php b/CRM/Custom/Form/Group.php index 43cb12da11..4153d002c6 100644 --- a/CRM/Custom/Form/Group.php +++ b/CRM/Custom/Form/Group.php @@ -107,8 +107,10 @@ class CRM_Custom_Form_Group 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 * * @@ -521,7 +523,8 @@ class CRM_Custom_Form_Group extends CRM_Core_Form { /** * Return a formatted list of relationship name. * - * @param array $list array of relationship name. + * @param array $list + * Array of relationship name. * * @return array of relationship name. */ diff --git a/CRM/Custom/Form/Option.php b/CRM/Custom/Form/Option.php index d26347d6e2..ad68ce8301 100644 --- a/CRM/Custom/Form/Option.php +++ b/CRM/Custom/Form/Option.php @@ -239,7 +239,8 @@ class CRM_Custom_Form_Option 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/Custom/Import/Form/MapField.php b/CRM/Custom/Import/Form/MapField.php index 16ce5d40b8..eef135f941 100644 --- a/CRM/Custom/Import/Form/MapField.php +++ b/CRM/Custom/Import/Form/MapField.php @@ -57,7 +57,8 @@ class CRM_Custom_Import_Form_MapField extends CRM_Contact_Import_Form_MapField { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Custom/Import/Parser/Api.php b/CRM/Custom/Import/Parser/Api.php index 38994300e8..3905d638ac 100644 --- a/CRM/Custom/Import/Parser/Api.php +++ b/CRM/Custom/Import/Parser/Api.php @@ -51,7 +51,8 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { /** * Handle the values in mapField mode * - * @param array $values the array of values belonging to this line + * @param array $values + * The array of values belonging to this line. * * @return boolean */ @@ -62,7 +63,8 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { /** * Handle the values in preview mode * - * @param array $values the array of values belonging to this line + * @param array $values + * The array of values belonging to this line. * * @return boolean the result of this processing */ @@ -71,7 +73,8 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { } /** - * @param array $values the array of values belonging to this line + * @param array $values + * The array of values belonging to this line. * * @return boolean the result of this processing * It is called from both the preview & the import actions @@ -121,8 +124,10 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { /** * Handle the values in import mode * - * @param int $onDuplicate the code for what action to take on duplicates - * @param array $values the array of values belonging to this line + * @param int $onDuplicate + * The code for what action to take on duplicates. + * @param array $values + * The array of values belonging to this line. * * @return boolean the result of this processing */ @@ -203,7 +208,8 @@ class CRM_Custom_Import_Parser_Api extends CRM_Custom_Import_Parser { /** * Return the field ids and names (with groups) for import purpose. * - * @param int $id Custom group ID + * @param int $id + * Custom group ID. * * @return array $importableFields * diff --git a/CRM/Custom/Page/Field.php b/CRM/Custom/Page/Field.php index 55a5f079fe..fdd68e5773 100644 --- a/CRM/Custom/Page/Field.php +++ b/CRM/Custom/Page/Field.php @@ -200,7 +200,8 @@ class CRM_Custom_Page_Field extends CRM_Core_Page { * * editing would involved modifying existing fields + adding data to new fields. * - * @param string $action the action to be invoked + * @param string $action + * The action to be invoked. * * @return void */ @@ -302,7 +303,8 @@ class CRM_Custom_Page_Field extends CRM_Core_Page { /** * Preview custom field * - * @param int $id custom field id + * @param int $id + * Custom field id. * * @return void */ diff --git a/CRM/Custom/Page/Group.php b/CRM/Custom/Page/Group.php index 0c2ba25100..8a9d732bfa 100644 --- a/CRM/Custom/Page/Group.php +++ b/CRM/Custom/Page/Group.php @@ -155,8 +155,10 @@ class CRM_Custom_Page_Group extends CRM_Core_Page { /** * Edit custom group * - * @param int $id custom group id - * @param string $action the action to be invoked + * @param int $id + * Custom group id. + * @param string $action + * The action to be invoked. * * @return void */ @@ -176,7 +178,8 @@ class CRM_Custom_Page_Group extends CRM_Core_Page { /** * Preview custom group * - * @param int $id custom group id + * @param int $id + * Custom group id. * * @return void */ @@ -193,7 +196,8 @@ class CRM_Custom_Page_Group extends CRM_Core_Page { /** * Browse all custom data groups. * - * @param string $action the action to be invoked + * @param string $action + * The action to be invoked. * * @return void */ diff --git a/CRM/Custom/Page/Option.php b/CRM/Custom/Page/Option.php index 449285cad6..04b4dfa163 100644 --- a/CRM/Custom/Page/Option.php +++ b/CRM/Custom/Page/Option.php @@ -237,7 +237,8 @@ ORDER BY weight, label * * editing would involved modifying existing fields + adding data to new fields. * - * @param string $action the action to be invoked + * @param string $action + * The action to be invoked. * * @return void */ -- 2.25.1