From 68c9fb83b3fa8517f8f7810484f317bd53ab28ca Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:09 -0800 Subject: [PATCH] INFRA-132 - CRM/Profile - Convert single-line @param to multi-line --- CRM/Profile/Form.php | 9 ++++++--- CRM/Profile/Form/Dynamic.php | 6 ++++-- CRM/Profile/Page/Dynamic.php | 6 ++++-- CRM/Profile/Page/Router.php | 3 ++- CRM/Profile/Selector/Listings.php | 24 ++++++++++++++++-------- 5 files changed, 32 insertions(+), 16 deletions(-) diff --git a/CRM/Profile/Form.php b/CRM/Profile/Form.php index c0dee2b655..a1e45d6627 100644 --- a/CRM/Profile/Form.php +++ b/CRM/Profile/Form.php @@ -866,9 +866,12 @@ class CRM_Profile_Form extends CRM_Core_Form { /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any - * @param CRM_Core_Form $form the form object + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. + * @param CRM_Core_Form $form + * The form object. * * @return true if no errors, else array of errors * @static diff --git a/CRM/Profile/Form/Dynamic.php b/CRM/Profile/Form/Dynamic.php index 7c05ad7d90..eb99256d9c 100644 --- a/CRM/Profile/Form/Dynamic.php +++ b/CRM/Profile/Form/Dynamic.php @@ -95,8 +95,10 @@ class CRM_Profile_Form_Dynamic extends CRM_Profile_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 CRM_Core_Form $form * * diff --git a/CRM/Profile/Page/Dynamic.php b/CRM/Profile/Page/Dynamic.php index 0f59e3d3fd..31b05bec99 100644 --- a/CRM/Profile/Page/Dynamic.php +++ b/CRM/Profile/Page/Dynamic.php @@ -103,8 +103,10 @@ class CRM_Profile_Page_Dynamic extends CRM_Core_Page { /** * Class constructor * - * @param int $id the contact id - * @param int $gid the group id + * @param int $id + * The contact id. + * @param int $gid + * The group id. * * @param $restrict * @param bool $skipPermission diff --git a/CRM/Profile/Page/Router.php b/CRM/Profile/Page/Router.php index 78d818d17c..035e3e5c33 100644 --- a/CRM/Profile/Page/Router.php +++ b/CRM/Profile/Page/Router.php @@ -41,7 +41,8 @@ class CRM_Profile_Page_Router extends CRM_Core_Page { /** * This is some kind of special-purpose router/front-controller for the various profile URLs. * - * @param $args array this array contains the arguments of the url + * @param $args + * Array this array contains the arguments of the url. * * @return string|void * @static diff --git a/CRM/Profile/Selector/Listings.php b/CRM/Profile/Selector/Listings.php index 3e24cf38bc..a11f97e010 100644 --- a/CRM/Profile/Selector/Listings.php +++ b/CRM/Profile/Selector/Listings.php @@ -292,8 +292,10 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR * 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 */ @@ -424,11 +426,16 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR /** * 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 */ @@ -717,7 +724,8 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR /** * Name of export file. * - * @param string $output type of output + * @param string $output + * Type of output. * * @return string name of the file */ -- 2.25.1