From 82d480a594de9c2f14ab82999a7d111d5f8cae3a Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:06 -0800 Subject: [PATCH] INFRA-132 - CRM/Batch - Convert single-line @param to multi-line --- CRM/Batch/BAO/Batch.php | 45 ++++++++++++++++++++++++++-------------- CRM/Batch/Form/Entry.php | 18 ++++++++++------ 2 files changed, 42 insertions(+), 21 deletions(-) diff --git a/CRM/Batch/BAO/Batch.php b/CRM/Batch/BAO/Batch.php index 6095e610b5..863db0b3eb 100755 --- a/CRM/Batch/BAO/Batch.php +++ b/CRM/Batch/BAO/Batch.php @@ -52,9 +52,12 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Create a new batch * - * @param array $params associated array - * @param array $ids associated array of ids - * @param string $context string + * @param array $params + * Associated array. + * @param array $ids + * Associated array of ids. + * @param string $context + * String. * * @return object $batch batch object */ @@ -76,8 +79,10 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Retrieve the information about the batch * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the flattened values + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the flattened values. * * @return array CRM_Batch_BAO_Batch object on success, null otherwise * @static @@ -95,7 +100,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Get profile id associated with the batch type * - * @param int $batchTypeId batch type id + * @param int $batchTypeId + * Batch type id. * * @return int $profileId profile id * @static @@ -133,7 +139,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Create entity batch entry - * @param array $params associated array + * @param array $params + * Associated array. * @return batch array */ public static function addBatchEntity(&$params) { @@ -145,7 +152,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Remove entries from entity batch - * @param array $params associated array + * @param array $params + * Associated array. * @return CRM_Batch_DAO_EntityBatch */ public static function removeBatchEntity($params) { @@ -158,7 +166,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Delete batch entry * - * @param int $batchId batch id + * @param int $batchId + * Batch id. * * @return void */ @@ -173,7 +182,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * This function is a wrapper for ajax batch selector * - * @param array $params associated array for params record id. + * @param array $params + * Associated array for params record id. * * @return array $batchList associated array of batch list */ @@ -238,7 +248,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Get list of batches * - * @param array $params associated array for params + * @param array $params + * Associated array for params. * * @return array */ @@ -343,7 +354,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Get count of batches * - * @param array $params associated array for params + * @param array $params + * Associated array for params. * * @return null|string */ @@ -359,7 +371,8 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { /** * Format where clause for getting lists of batches * - * @param array $params associated array for params + * @param array $params + * Associated array for params. * * @return string */ @@ -555,8 +568,10 @@ class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch { * Function for exporting financial accounts, currently we support CSV and IIF format * @see http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+Specifications+-++Batches#CiviAccountsSpecifications-Batches-%C2%A0Overviewofimplementation * - * @param array $batchIds associated array of batch ids - * @param string $exportFormat export format + * @param array $batchIds + * Associated array of batch ids. + * @param string $exportFormat + * Export format. * * @return void * diff --git a/CRM/Batch/Form/Entry.php b/CRM/Batch/Form/Entry.php index 2b338af305..395185feca 100755 --- a/CRM/Batch/Form/Entry.php +++ b/CRM/Batch/Form/Entry.php @@ -260,9 +260,12 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { /** * Form validations * - * @param array $params posted values of the form - * @param array $files list of errors to be posted back to the form - * @param array $self form object + * @param array $params + * Posted values of the form. + * @param array $files + * List of errors to be posted back to the form. + * @param array $self + * Form object. * * @return array list of errors to be posted back to the form * @static @@ -405,7 +408,8 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { /** * Process contribution records * - * @param array $params associated array of submitted values + * @param array $params + * Associated array of submitted values. * * * @return void @@ -574,7 +578,8 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { /** * Process membership records * - * @param array $params associated array of submitted values + * @param array $params + * Associated array of submitted values. * * * @return bool @@ -816,7 +821,8 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { /** * Update contact information * - * @param array $value associated array of submitted values + * @param array $value + * Associated array of submitted values. * * * @return void -- 2.25.1