INFRA-132 - Fix missing newlines in comments
authorColeman Watts <coleman@civicrm.org>
Fri, 9 Jan 2015 18:50:04 +0000 (13:50 -0500)
committerColeman Watts <coleman@civicrm.org>
Fri, 9 Jan 2015 18:54:36 +0000 (13:54 -0500)
28 files changed:
CRM/Campaign/BAO/Campaign.php
CRM/Campaign/BAO/Survey.php
CRM/Case/BAO/Case.php
CRM/Contact/BAO/Contact/Utils.php
CRM/Contact/BAO/GroupOrganization.php
CRM/Contact/BAO/Relationship.php
CRM/Contact/Form/Contact.php
CRM/Contact/Form/Edit/Household.php
CRM/Contact/Form/Inline/Email.php
CRM/Contact/Form/Inline/IM.php
CRM/Contact/Form/Inline/OpenID.php
CRM/Contact/Form/Inline/Phone.php
CRM/Contribute/BAO/Contribution.php
CRM/Core/BAO/CustomField.php
CRM/Core/BAO/Mapping.php
CRM/Core/BAO/Navigation.php
CRM/Core/BAO/Note.php
CRM/Core/BAO/Tag.php
CRM/Core/BAO/UFGroup.php
CRM/Core/ShowHideBlocks.php
CRM/Dedupe/BAO/RuleGroup.php
CRM/Event/BAO/Participant.php
CRM/Mailing/BAO/Mailing.php
CRM/Report/BAO/ReportInstance.php
CRM/Utils/Pager.php
CRM/Utils/Token.php
api/v3/Case.php
api/v3/GroupContact.php

index 335c966f5aa182be6b2021ce402000ce9af9eaae..1c8111e74330bf0760371ebb28b8269c99bc50df 100644 (file)
@@ -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,
index c3045e67b320adc055e8ca2f9fd1af85c823400b..cbe8ca9b7f7c18c9f0fb0c840329175601bbc3aa 100644 (file)
@@ -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();
index da805b9dec3499048b5ff8a2106fdb53d1482262..ef8db7a6695f2ab5193ef60d9872fdacbc9c7873 100644 (file)
@@ -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) ||
index 0b99c67c9840fd07742bef71011ccca2e1520455..1883d94fad103b6e71d28c67b6d939d0b4ffd1d2 100644 (file)
@@ -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();
index 3e91e678d8f862f2119cf207c928f80f52070505..755105611f97c81d5a90cf31eb0e74954ec7c461 100644 (file)
@@ -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;
index 43ee06e48de5b111204f2b2b305924911db02940..afdcbeb5ae48d9066edf3f92ea524d5a861a87de 100644 (file)
@@ -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);
index e0cb1c9fbce564b4aa0cbcb7df76379559a03caf..8277a2fd7baaffe07cb9bd53d941c300984dc0ff 100644 (file)
@@ -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;
index 3a5657882414f4d9a93d44a18aa5e6a7c0c3b285..814bb907a71f2f807bdf0b0a9f6d4b0faa60f223 100644 (file)
@@ -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();
index 2e4d668ff42f26b503359b0e199e427021892e49..d52fa5972699706d06492225372803e50ba47a17 100644 (file)
@@ -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();
index 698362e5c39dd58ed9b5c61bb24419db951461f0..fc1049a52d036cc3f7e80b0507182e7463a798d8 100644 (file)
@@ -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();
index 8a79fa730bc63760ac7c8e03ec1cd6755966b93d..bc1014db2f06f49a51856fbec9eea1ac2ad2bd64 100644 (file)
@@ -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();
index 6634723a92ac33f09b249782febd649d447ddc9f..6297a8d221a22fb3aecf9b39ee319148f911d9b0 100644 (file)
@@ -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();
index 2c83e42c0e544b82d7b580848ed82e807236d0b5..3f18eaaab4a373ffa22c8baa230cb5436aac1443 100644 (file)
@@ -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) {
index 3b8536e8a0c35add12554fa5634f8f64a7adc244..3878dc967778708968f6ef0f72ed2934914ac62c 100644 (file)
@@ -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;
index 574046997fa411efd5556a477d146c41faeebe79..3b5d659e4a5e2213ce2e13d88deb15a7e5fea4a8 100644 (file)
@@ -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();
index 1be9ede08bfc8ec531e62643c83769598fdf831f..53dad5cabcdc234d0b1d04d1fcd07feeaf52b8e2 100644 (file)
@@ -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();
index 557f5cedcf0285b935279296d50ab114c3728c86..84f8aa61b60e71fe6edf8979dc9dc10d92f2cf51 100644 (file)
@@ -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) {
index e845b11b381e53ca4a953b4056402a57a8958a90..475bb5f6ff9f83e448eeaa65899cd532ce837a96 100644 (file)
@@ -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() {
index 0ad80bebb1526cedb7db31fcfe30d19d483299da..e15191e08a5e6fc21da359a82cef2d03d8053035 100644 (file)
@@ -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();
index 71daf653784f90952be8653847b43843e410e5e6..feeb368fa788fdc6d2c0e2942457bb4b28be5130 100644 (file)
@@ -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)) {
index b181534e7bdd1ea3b11dd587861359a48867550c..6f76661c1e201d2785fb74c45a1d18ba61199658 100644 (file)
@@ -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();
index 892657bf5a131788dd00a88f5edec685d845b875..cc905d78e4ff83b852b7efc4497642f1e926847a 100644 (file)
@@ -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,
index a4eeefb70af0e518cb5c6245beeffcdb0485ae16..1e6bd12223bace82de0965ebc1cca2b645d388c3 100644 (file)
@@ -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;
index 9c0575e8df2bbd1969d53341ba9c7bd707dae8f9..3475012449b6504a0e52f6af602bcf3f2c670818 100644 (file)
@@ -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();
index 6a469c5c09bd71f875b2e010e5ff021a6f4f948a..79f8ad962f64dfc95b4b73580ca5c6ed2f6884e2 100644 (file)
@@ -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) {
index 7bf57a67f7b09222a83e14b7a0d5edc51993b035..2927be5eae84b6af4d2f15b5e725a9f41707263a 100644 (file)
@@ -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) {
index f1ca95f25970ca92689b871d09d3568ee817fcf4..238bd2af79fb3379d8e401757f436d0c1c2c105c 100644 (file)
@@ -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) {
index eca18fec88e8dbd3a7f3a0e30bf81b4d46a85a32..422b6e4644ab198853e86f2dab916a4dd444b109 100644 (file)
@@ -125,7 +125,8 @@ function civicrm_api3_group_contact_create($params) {
  *
  * @param <type> $params
  *
- * @return array <type>@deprecated
+ * @return array <type>
+ * @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 <type> $params
  *
- * @return array|int <type>@deprecated
+ * @return array|int <type>
+ * @deprecated
  */
 function civicrm_api3_group_contact_pending($params) {
   $params['status'] = 'Pending';