From e0b82b44738ae827c23c946bd511f86c639fc6e4 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Fri, 9 Jan 2015 13:50:04 -0500 Subject: [PATCH] INFRA-132 - Fix missing newlines in comments --- CRM/Campaign/BAO/Campaign.php | 3 ++- CRM/Campaign/BAO/Survey.php | 15 ++++++++++----- CRM/Case/BAO/Case.php | 3 ++- CRM/Contact/BAO/Contact/Utils.php | 6 ++++-- CRM/Contact/BAO/GroupOrganization.php | 3 ++- CRM/Contact/BAO/Relationship.php | 3 ++- CRM/Contact/Form/Contact.php | 9 ++++++--- CRM/Contact/Form/Edit/Household.php | 3 ++- CRM/Contact/Form/Inline/Email.php | 3 ++- CRM/Contact/Form/Inline/IM.php | 3 ++- CRM/Contact/Form/Inline/OpenID.php | 3 ++- CRM/Contact/Form/Inline/Phone.php | 3 ++- CRM/Contribute/BAO/Contribution.php | 3 ++- CRM/Core/BAO/CustomField.php | 3 ++- CRM/Core/BAO/Mapping.php | 9 ++++++--- CRM/Core/BAO/Navigation.php | 3 ++- CRM/Core/BAO/Note.php | 3 ++- CRM/Core/BAO/Tag.php | 3 ++- CRM/Core/BAO/UFGroup.php | 3 ++- CRM/Core/ShowHideBlocks.php | 3 ++- CRM/Dedupe/BAO/RuleGroup.php | 3 ++- CRM/Event/BAO/Participant.php | 3 ++- CRM/Mailing/BAO/Mailing.php | 6 ++++-- CRM/Report/BAO/ReportInstance.php | 3 ++- CRM/Utils/Pager.php | 3 ++- CRM/Utils/Token.php | 3 ++- api/v3/Case.php | 3 ++- api/v3/GroupContact.php | 6 ++++-- 28 files changed, 78 insertions(+), 39 deletions(-) diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index 335c966f5a..1c8111e743 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -153,7 +153,8 @@ class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { * @param bool $appendDatesToTitle * @param bool $forceAll * - * @return mixed $campaigns a set of campaigns.@access public + * @return mixed $campaigns a set of campaigns. + * @access public */ public static function getCampaigns( $includeId = NULL, diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index c3045e67b3..cbe8ca9b7f 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -518,7 +518,8 @@ Group By contact.id"; * @param int $interviewerId * @param array $statusIds * - * @return array $activityDetails array of survey activity.@static + * @return array $activityDetails array of survey activity. + * @static */ static function voterActivityDetails( $surveyId, $voterIds, $interviewerId = NULL, @@ -581,7 +582,8 @@ INNER JOIN civicrm_activity_contact activityAssignment * @param null $statusIds * @param null $voterIds * @param bool $onlyCount - * @return array $activities an array of survey activity.@static + * @return array $activities an array of survey activity. + * @static */ static function getSurveyActivities( $surveyId, @@ -719,7 +721,8 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a * This function retrieve all option groups which are created as a result set * * @param string $valueColumnName - * @return array $resultSets an array of option groups.@static + * @return array $resultSets an array of option groups. + * @static */ public static function getResultSets($valueColumnName = 'title') { $resultSets = array(); @@ -768,7 +771,8 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a * * @param int $surveyId * Survey id. - * @return array $responseOptions an array of option values@static + * @return array $responseOptions an array of option values + * @static */ public static function getResponsesOptions($surveyId) { $responseOptions = array(); @@ -790,7 +794,8 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a * @param int $surveyId * @param bool $enclosedInUL * @param string $extraULName - * @return array|string $url array of permissioned links@static + * @return array|string $url array of permissioned links + * @static */ public static function buildPermissionLinks($surveyId, $enclosedInUL = FALSE, $extraULName = 'more') { $menuLinks = array(); diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index da805b9dec..ef8db7a669 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -1600,7 +1600,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param int $file * Email sent. * - * @return array|void $activity object of newly creted activity via email@access public + * @return array|void $activity object of newly creted activity via email + * @access public */ public static function recordActivityViaEmail($file) { if (!file_exists($file) || diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index 0b99c67c98..1883d94fad 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -691,7 +691,8 @@ LEFT JOIN civicrm_email ce ON ( ce.contact_id=c.id AND ce.is_primary = 1 ) * @param array $returnProperties * Array of return elements. * - * @return array $contactDetails array of contact info.@static + * @return array $contactDetails array of contact info. + * @static */ public static function contactDetails($componentIds, $componentName, $returnProperties = array()) { $contactDetails = array(); @@ -869,7 +870,8 @@ Group By componentId"; * @param array $addresses * Associated array of. * - * @return array $contactNames associated array of contact names@static + * @return array $contactNames associated array of contact names + * @static */ public static function getAddressShareContactNames(&$addresses) { $contactNames = array(); diff --git a/CRM/Contact/BAO/GroupOrganization.php b/CRM/Contact/BAO/GroupOrganization.php index 3e91e678d8..755105611f 100644 --- a/CRM/Contact/BAO/GroupOrganization.php +++ b/CRM/Contact/BAO/GroupOrganization.php @@ -145,7 +145,8 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio * @param int $groupOrganizationID * Group organization id that needs to be deleted. * - * @return mixed|null $results no of deleted group organization on success, false otherwise@access public + * @return mixed|null $results no of deleted group organization on success, false otherwise + * @access public */ public static function deleteGroupOrganization($groupOrganizationID) { $results = NULL; diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index 43ee06e48d..afdcbeb5ae 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -1551,7 +1551,8 @@ SELECT count(*) * @param $contactIds * Contact Ids. * - * @return array $currentEmployer array of the current employer@static + * @return array $currentEmployer array of the current employer + * @static */ public static function getCurrentEmployer($contactIds) { $contacts = implode(',', $contactIds); diff --git a/CRM/Contact/Form/Contact.php b/CRM/Contact/Form/Contact.php index e0cb1c9fbc..8277a2fd7b 100644 --- a/CRM/Contact/Form/Contact.php +++ b/CRM/Contact/Form/Contact.php @@ -588,7 +588,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * @param int $contactId * Contact id if doing update. * - * @return bool $primaryID email/openId@static + * @return bool $primaryID email/openId + * @static */ public static function formRule($fields, &$errors, $contactId = NULL) { $config = CRM_Core_Config::singleton(); @@ -1195,7 +1196,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * @param array $params * of key value consist of address blocks. * - * @return array $parseSuccess as array of sucess/fails for each address block@static + * @return array $parseSuccess as array of sucess/fails for each address block + * @static */ public function parseAddress(&$params) { $parseSuccess = $parsedFields = array(); @@ -1281,7 +1283,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * @param array $parseResult * An array of address blk instance and its status. * - * @return null|string $statusMsg string status message for all address blocks.@static + * @return null|string $statusMsg string status message for all address blocks. + * @static */ public static function parseAddressStatusMsg($parseResult) { $statusMsg = NULL; diff --git a/CRM/Contact/Form/Edit/Household.php b/CRM/Contact/Form/Edit/Household.php index 3a56578824..814bb907a7 100644 --- a/CRM/Contact/Form/Edit/Household.php +++ b/CRM/Contact/Form/Edit/Household.php @@ -87,7 +87,8 @@ class CRM_Contact_Form_Edit_Household { * Unused. * @param int $contactID * - * @return array|bool $error@static + * @return array|bool $error + * @static */ public static function formRule($fields, $files, $contactID = NULL) { $errors = array(); diff --git a/CRM/Contact/Form/Inline/Email.php b/CRM/Contact/Form/Inline/Email.php index 2e4d668ff4..d52fa59726 100644 --- a/CRM/Contact/Form/Inline/Email.php +++ b/CRM/Contact/Form/Inline/Email.php @@ -103,7 +103,8 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { * @param array $errors * List of errors to be posted back to the form. * - * @return array $errors@static + * @return array $errors + * @static */ public static function formRule($fields, $errors) { $hasData = $hasPrimary = $errors = array(); diff --git a/CRM/Contact/Form/Inline/IM.php b/CRM/Contact/Form/Inline/IM.php index 698362e5c3..fc1049a52d 100644 --- a/CRM/Contact/Form/Inline/IM.php +++ b/CRM/Contact/Form/Inline/IM.php @@ -103,7 +103,8 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { * @param array $errors * List of errors to be posted back to the form. * - * @return array $errors@static + * @return array $errors + * @static */ public static function formRule($fields, $errors) { $hasData = $hasPrimary = $errors = array(); diff --git a/CRM/Contact/Form/Inline/OpenID.php b/CRM/Contact/Form/Inline/OpenID.php index 8a79fa730b..bc1014db2f 100644 --- a/CRM/Contact/Form/Inline/OpenID.php +++ b/CRM/Contact/Form/Inline/OpenID.php @@ -103,7 +103,8 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { * @param array $errors * List of errors to be posted back to the form. * - * @return array $errors@static + * @return array $errors + * @static */ public static function formRule($fields, $errors) { $hasData = $hasPrimary = $errors = array(); diff --git a/CRM/Contact/Form/Inline/Phone.php b/CRM/Contact/Form/Inline/Phone.php index 6634723a92..6297a8d221 100644 --- a/CRM/Contact/Form/Inline/Phone.php +++ b/CRM/Contact/Form/Inline/Phone.php @@ -103,7 +103,8 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { * @param array $errors * List of errors to be posted back to the form. * - * @return array $errors@static + * @return array $errors + * @static */ public static function formRule($fields, $errors) { $hasData = $hasPrimary = $errors = array(); diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 2c83e42c0e..3f18eaaab4 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -771,7 +771,8 @@ INNER JOIN civicrm_contact contact ON ( contact.id = civicrm_contribution.conta * * @param int $id * - * @return mixed|null $results no of deleted Contribution on success, false otherwise@access public + * @return mixed|null $results no of deleted Contribution on success, false otherwise + * @access public * @static */ public static function deleteContribution($id) { diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index 3b8536e8a0..3878dc9677 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -2106,7 +2106,8 @@ AND cf.id = %1"; * for inactive fields : CRM-5369 * * - * @return mixed $customOptionGroup@static + * @return mixed $customOptionGroup + * @static */ public static function &customOptionGroup($includeFieldIds = NULL) { static $customOptionGroup = NULL; diff --git a/CRM/Core/BAO/Mapping.php b/CRM/Core/BAO/Mapping.php index 574046997f..3b5d659e4a 100644 --- a/CRM/Core/BAO/Mapping.php +++ b/CRM/Core/BAO/Mapping.php @@ -214,7 +214,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * @param int $smartGroupId * Smart group id. * - * @return array $returnFields associated array of elements@static + * @return array $returnFields associated array of elements + * @static */ public static function getFormattedFields($smartGroupId) { $returnFields = array(); @@ -935,7 +936,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * @param int $customfieldId * Related file id. * - * @return null|string $customGroupName all custom group names@static + * @return null|string $customGroupName all custom group names + * @static */ public static function getCustomGroupName($customfieldId) { if ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($customfieldId)) { @@ -959,7 +961,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * Row no of the fields. * * - * @return array $returnFields formatted associated array of elements@static + * @return array $returnFields formatted associated array of elements + * @static */ public static function formattedFields(&$params, $row = FALSE) { $fields = array(); diff --git a/CRM/Core/BAO/Navigation.php b/CRM/Core/BAO/Navigation.php index 1be9ede08b..53dad5cabc 100644 --- a/CRM/Core/BAO/Navigation.php +++ b/CRM/Core/BAO/Navigation.php @@ -154,7 +154,8 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { * @param int $menuID * Menu id. * - * @return int $weight string@static + * @return int $weight string + * @static */ public static function calculateWeight($parentID = NULL, $menuID = NULL) { $domainID = CRM_Core_Config::domainID(); diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index 557f5cedcf..84f8aa61b6 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -289,7 +289,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * @param bool $showStatus * Do we need to set status or not. * - * @return mixed|NULL $return no of deleted notes on success, FALSE otherwise@access public + * @return mixed|NULL $return no of deleted notes on success, FALSE otherwise + * @access public * @static */ public static function del($id, $showStatus = TRUE) { diff --git a/CRM/Core/BAO/Tag.php b/CRM/Core/BAO/Tag.php index e845b11b38..475bb5f6ff 100644 --- a/CRM/Core/BAO/Tag.php +++ b/CRM/Core/BAO/Tag.php @@ -447,7 +447,8 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { /** * Get the tags that are not children of a tagset. * - * @return array $tags associated array of tag name and id@access public + * @return array $tags associated array of tag name and id + * @access public * @static */ public static function getTagsNotInTagset() { diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index 0ad80bebb1..e15191e08a 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -2696,7 +2696,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @param $fields * @param $defaults * - * @return mixed $defaults@static + * @return mixed $defaults + * @static */ public static function setRegisterDefaults(&$fields, &$defaults) { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Core/ShowHideBlocks.php b/CRM/Core/ShowHideBlocks.php index 71daf65378..feeb368fa7 100644 --- a/CRM/Core/ShowHideBlocks.php +++ b/CRM/Core/ShowHideBlocks.php @@ -63,7 +63,8 @@ class CRM_Core_ShowHideBlocks { * @param array $hide * Initial value of hide array. * - * @return \CRM_Core_ShowHideBlocks the newly created object@access public + * @return \CRM_Core_ShowHideBlocks the newly created object + * @access public */ public function __construct($show = NULL, $hide = NULL) { if (!empty($show)) { diff --git a/CRM/Dedupe/BAO/RuleGroup.php b/CRM/Dedupe/BAO/RuleGroup.php index b181534e7b..6f76661c1e 100644 --- a/CRM/Dedupe/BAO/RuleGroup.php +++ b/CRM/Dedupe/BAO/RuleGroup.php @@ -379,7 +379,8 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { * * @param array $params * - * @return array (rule field => weight) array and threshold associated to rule group@access public + * @return array (rule field => weight) array and threshold associated to rule group + * @access public */ public static function dedupeRuleFieldsWeight($params) { $rgBao = new CRM_Dedupe_BAO_RuleGroup(); diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php index 892657bf5a..cc905d78e4 100644 --- a/CRM/Event/BAO/Participant.php +++ b/CRM/Event/BAO/Participant.php @@ -352,7 +352,8 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { * @param bool $returnWaitingCount * @param bool $considerTestParticipant * - * @return bool|int|null|string 1. false => If event having some empty spaces.@static + * @return bool|int|null|string 1. false => If event having some empty spaces. + * @static */ static function eventFull( $eventId, diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index a4eeefb70a..1e6bd12223 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -1063,7 +1063,8 @@ ORDER BY civicrm_email.is_bulkmail DESC * * @param bool $isForward * - * @return array (reference) array array ref that hold array refs to the verp info, urls, and headers@access private + * @return array (reference) array array ref that hold array refs to the verp info, urls, and headers + * @access private */ private function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) { $config = CRM_Core_Config::singleton(); @@ -2718,7 +2719,8 @@ SELECT $mailing.id as mailing_id * * @param bool $isSMS * - * @return array $report array content/component.@access public + * @return array $report array content/component. + * @access public */ public static function getMailingContent(&$report, &$form, $isSMS = FALSE) { $htmlHeader = $textHeader = NULL; diff --git a/CRM/Report/BAO/ReportInstance.php b/CRM/Report/BAO/ReportInstance.php index 9c0575e8df..3475012449 100644 --- a/CRM/Report/BAO/ReportInstance.php +++ b/CRM/Report/BAO/ReportInstance.php @@ -231,7 +231,8 @@ class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance { * * @param int $id * - * @return mixed $results no of deleted Instance on success, false otherwise@access public + * @return mixed $results no of deleted Instance on success, false otherwise + * @access public */ public static function del($id = NULL) { $dao = new CRM_Report_DAO_ReportInstance(); diff --git a/CRM/Utils/Pager.php b/CRM/Utils/Pager.php index 6a469c5c09..79f8ad962f 100644 --- a/CRM/Utils/Pager.php +++ b/CRM/Utils/Pager.php @@ -78,7 +78,8 @@ class CRM_Utils_Pager extends Pager_Sliding { * @internal param \csvString $string the title of the link to be displayed for the export * @internal param \perPage $int the number of items displayed per page * - * @return \CRM_Utils_Pager the newly created and initialized pager object@access public + * @return \CRM_Utils_Pager the newly created and initialized pager object + * @access public */ public function __construct($params) { if ($params['status'] === NULL) { diff --git a/CRM/Utils/Token.php b/CRM/Utils/Token.php index 7bf57a67f7..2927be5eae 100644 --- a/CRM/Utils/Token.php +++ b/CRM/Utils/Token.php @@ -1088,7 +1088,8 @@ class CRM_Utils_Token { * @param string $string * The input string to parse for tokens. * - * @return array $tokens array of tokens mentioned in field@access public + * @return array $tokens array of tokens mentioned in field + * @access public * @static */ public static function getTokens($string) { diff --git a/api/v3/Case.php b/api/v3/Case.php index f1ca95f259..238bd2af79 100644 --- a/api/v3/Case.php +++ b/api/v3/Case.php @@ -196,7 +196,8 @@ function _civicrm_api3_case_delete_spec(&$params) { * {@getfields case_get} * * @throws API_Exception - * @return array (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found@access public + * @return array (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found + * @access public * @todo Erik Hommel 16 dec 2010 check if all DB fields are returned */ function civicrm_api3_case_get($params) { diff --git a/api/v3/GroupContact.php b/api/v3/GroupContact.php index eca18fec88..422b6e4644 100644 --- a/api/v3/GroupContact.php +++ b/api/v3/GroupContact.php @@ -125,7 +125,8 @@ function civicrm_api3_group_contact_create($params) { * * @param $params * - * @return array @deprecated + * @return array + * @deprecated */ function civicrm_api3_group_contact_delete($params) { $params['status'] = CRM_Utils_Array::value('status', $params, empty($params['skip_undelete']) ? 'Removed' : 'Deleted'); @@ -145,7 +146,8 @@ function _civicrm_api3_group_contact_delete_spec(&$params) { * * @param $params * - * @return array|int @deprecated + * @return array|int + * @deprecated */ function civicrm_api3_group_contact_pending($params) { $params['status'] = 'Pending'; -- 2.25.1