From 691efc591352c599bf4464f75c82796f09209981 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:06 -0800 Subject: [PATCH] INFRA-132 - CRM/Badge - Convert single-line @param to multi-line --- CRM/Badge/BAO/Badge.php | 18 ++++++++++++------ CRM/Badge/BAO/Layout.php | 24 ++++++++++++++++-------- 2 files changed, 28 insertions(+), 14 deletions(-) diff --git a/CRM/Badge/BAO/Badge.php b/CRM/Badge/BAO/Badge.php index 93d5b9556a..74931c9323 100644 --- a/CRM/Badge/BAO/Badge.php +++ b/CRM/Badge/BAO/Badge.php @@ -45,8 +45,10 @@ class CRM_Badge_BAO_Badge { /** * This function is called to create name label pdf * - * @param array $participants associated array with participant info - * @param array $layoutInfo associated array which contains meta data about format/layout + * @param array $participants + * Associated array with participant info. + * @param array $layoutInfo + * Associated array which contains meta data about format/layout. * * @return void */ @@ -75,8 +77,10 @@ class CRM_Badge_BAO_Badge { /** * Funtion to create structure and add meta data according to layout * - * @param array $row row element that needs to be formatted - * @param array $layout layout meta data + * @param array $row + * Row element that needs to be formatted. + * @param array $layout + * Layout meta data. * * @return array $formattedRow row with meta data */ @@ -347,7 +351,8 @@ class CRM_Badge_BAO_Badge { /** * Helper function to print images * - * @param string $img image url + * @param string $img + * Image url. * * @param string $x * @param string $y @@ -394,7 +399,8 @@ class CRM_Badge_BAO_Badge { /** * Build badges parameters before actually creating badges. * - * @param array $params associated array of submitted values + * @param array $params + * Associated array of submitted values. * @param CRM_Core_Form $form * * @return void diff --git a/CRM/Badge/BAO/Layout.php b/CRM/Badge/BAO/Layout.php index 0bbe2ce1fc..a5813ff910 100644 --- a/CRM/Badge/BAO/Layout.php +++ b/CRM/Badge/BAO/Layout.php @@ -46,8 +46,10 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { * retrieves the relevant objects. It also stores all the retrieved * values in the default array * - * @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 CRM_Core_DAO_PrintLabel object on success, null otherwise * @static @@ -65,8 +67,10 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { /** * Update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $is_active value we want to set the is_active field + * @param int $id + * Id of the database record. + * @param bool $is_active + * Value we want to set the is_active field. * * @return Object DAO object on success, null otherwise * @@ -79,7 +83,8 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { /** * Add a name label * - * @param array $params reference array contains the values submitted by the form + * @param array $params + * Reference array contains the values submitted by the form. * * @static * @@ -120,7 +125,8 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { /** * Delete name labels * - * @param int $printLabelId ID of the name label to be deleted. + * @param int $printLabelId + * ID of the name label to be deleted. * * @static */ @@ -150,7 +156,8 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { /** * Build layout structure * - * @param array $params associated array of submitted values + * @param array $params + * Associated array of submitted values. * * @return array $formattedLayout array formatted array */ @@ -167,7 +174,8 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { /** * Decode encoded data and return as an array * - * @param json $jsonData json object + * @param json $jsonData + * Json object. * * @return array associated array of decoded elements * @static -- 2.25.1