From 8551163557fef741b59acba175d56cc7b359c166 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:08 -0800 Subject: [PATCH] INFRA-132 - CRM/Grant - Convert single-line @param to multi-line --- CRM/Grant/BAO/Grant.php | 24 ++++++++++++++------- CRM/Grant/Form/Task.php | 3 ++- CRM/Grant/Selector/Search.php | 36 ++++++++++++++++++++----------- CRM/Grant/StateMachine/Search.php | 3 ++- 4 files changed, 44 insertions(+), 22 deletions(-) diff --git a/CRM/Grant/BAO/Grant.php b/CRM/Grant/BAO/Grant.php index bc1b4ae144..f34a1817f0 100644 --- a/CRM/Grant/BAO/Grant.php +++ b/CRM/Grant/BAO/Grant.php @@ -126,8 +126,10 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { /** * Fetch object based on array of properties * - * @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_Grant_BAO_ManageGrant object * @static @@ -145,8 +147,10 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { /** * Add grant * - * @param array $params reference array contains the values submitted by the form - * @param array $ids reference array contains the id + * @param array $params + * Reference array contains the values submitted by the form. + * @param array $ids + * Reference array contains the id. * * @static * @@ -245,8 +249,10 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { /** * Create the event * - * @param array $params reference array contains the values submitted by the form - * @param array $ids reference array contains the id + * @param array $params + * Reference array contains the values submitted by the form. + * @param array $ids + * Reference array contains the id. * * @return object * @static @@ -307,7 +313,8 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { /** * Delete the Contact * - * @param int $id contact id + * @param int $id + * Contact id. * * @return bool * @@ -323,7 +330,8 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { /** * Delete the grant * - * @param int $id grant id + * @param int $id + * Grant id. * * @return bool|mixed * @static diff --git a/CRM/Grant/Form/Task.php b/CRM/Grant/Form/Task.php index 8d5da0dd7e..47229a25b5 100644 --- a/CRM/Grant/Form/Task.php +++ b/CRM/Grant/Form/Task.php @@ -148,7 +148,8 @@ class CRM_Grant_Form_Task extends CRM_Core_Form { * Simple shell that derived classes can call to add buttons to * the form with a customized title for the main Submit * - * @param string $title title of the main button + * @param string $title + * Title of the main button. * @param string $nextType * @param string $backType * diff --git a/CRM/Grant/Selector/Search.php b/CRM/Grant/Selector/Search.php index 1278d0dbbb..c6d4abcdab 100644 --- a/CRM/Grant/Selector/Search.php +++ b/CRM/Grant/Selector/Search.php @@ -132,11 +132,15 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co /** * Class constructor * - * @param array $queryParams array of parameters for query + * @param array $queryParams + * Array of parameters for query. * @param \const|int $action - action of search basic or advanced. - * @param string $grantClause if the caller wants to further restrict the search - * @param boolean $single are we dealing only with one contact? - * @param int $limit how many participations do we want returned + * @param string $grantClause + * If the caller wants to further restrict the search. + * @param bool $single + * Are we dealing only with one contact?. + * @param int $limit + * How many participations do we want returned. * * @param string $context * @@ -255,11 +259,16 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co /** * Returns all the rows in the given offset and rowCount * * - * @param enum $action the action being performed - * @param int $offset the row number to start from - * @param int $rowCount the number of rows to return - * @param string $sort the sql string that describes the sort order - * @param enum $output what should the result set include (web/email/csv) + * @param enum $action + * The action being performed. + * @param int $offset + * The row number to start from. + * @param int $rowCount + * The number of rows to return. + * @param string $sort + * The sql string that describes the sort order. + * @param enum $output + * What should the result set include (web/email/csv). * * @return int the total number of rows for this action */ @@ -335,8 +344,10 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * - * @param string $action the action being performed - * @param enum $output what should the result set include (web/email/csv) + * @param string $action + * The action being performed. + * @param enum $output + * What should the result set include (web/email/csv). * * @return array the column headers that need to be displayed */ @@ -405,7 +416,8 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co /** * Name of export file. * - * @param string $output type of output + * @param string $output + * Type of output. * * @return string name of the file */ diff --git a/CRM/Grant/StateMachine/Search.php b/CRM/Grant/StateMachine/Search.php index 9810c79f6f..34bb2ce736 100644 --- a/CRM/Grant/StateMachine/Search.php +++ b/CRM/Grant/StateMachine/Search.php @@ -74,7 +74,8 @@ class CRM_Grant_StateMachine_Search extends CRM_Core_StateMachine { * to avoid using conditional state machine, much more efficient * and simpler * - * @param CRM_Core_Controller $controller the controller object + * @param CRM_Core_Controller $controller + * The controller object. * * @param string $formName * -- 2.25.1