From d424ffde71135407dc6297d0d1f0c85fa6413d7d Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Mon, 12 Jan 2015 10:54:21 -0500 Subject: [PATCH] INFRA-132 - Docblock formatting fixes --- CRM/ACL/Form/WordPress/Permissions.php | 1 - CRM/Activity/BAO/Query.php | 1 - CRM/Campaign/BAO/Campaign.php | 20 +++++-- CRM/Campaign/BAO/Query.php | 1 - CRM/Contact/BAO/Query.php | 5 +- CRM/Contact/Form/Domain.php | 13 +--- CRM/Contact/Form/Search.php | 2 +- CRM/Contact/Form/Search/Basic.php | 2 +- CRM/Contact/Form/Search/Custom/Group.php | 4 +- CRM/Contact/Form/Task/AddToGroup.php | 4 +- CRM/Contact/Form/Task/AddToHousehold.php | 5 +- CRM/Contact/Form/Task/Batch.php | 4 +- CRM/Contact/Form/Task/PickProfile.php | 4 +- CRM/Contact/Form/Task/ProximityCommon.php | 4 +- CRM/Contribute/BAO/Contribution.php | 12 +--- CRM/Contribute/BAO/ContributionSoft.php | 12 ++-- CRM/Contribute/Form/AbstractEditPayment.php | 2 +- CRM/Contribute/Form/Contribution.php | 3 +- CRM/Contribute/Form/Task/Batch.php | 4 +- CRM/Contribute/Form/Task/PickProfile.php | 4 +- CRM/Core/BAO/Block.php | 5 +- CRM/Core/BAO/CustomQuery.php | 1 - CRM/Core/BAO/File.php | 5 +- CRM/Core/BAO/FinancialTrxn.php | 11 ++-- CRM/Core/BAO/LocationType.php | 6 +- CRM/Core/BAO/Phone.php | 6 +- CRM/Core/BAO/UFMatch.php | 9 +-- CRM/Core/Component/Info.php | 2 +- CRM/Core/DAO.php | 5 +- CRM/Core/DAO/permissions.php | 1 - CRM/Core/Error.php | 6 +- CRM/Core/Exception.php | 1 - CRM/Core/JobManager.php | 29 ++------- CRM/Core/OptionGroup.php | 9 ++- CRM/Core/Page/AJAX/RecurringEntity.php | 1 - CRM/Core/Page/Basic.php | 5 +- CRM/Core/Page/Inline/Help.php | 1 - CRM/Core/Payment/BaseIPN.php | 7 +-- CRM/Core/Payment/PayJunction.php | 12 +--- CRM/Core/Payment/PaymentExpress.php | 16 ++--- CRM/Core/Payment/PaymentExpressIPN.php | 14 ++--- CRM/Core/Payment/Realex.php | 10 ++-- CRM/Core/PseudoConstant.php | 6 +- CRM/Core/TableHierarchy.php | 1 - CRM/Event/BAO/Query.php | 1 - CRM/Event/Form/ManageEvent/Repeat.php | 1 - CRM/Event/Form/Participant.php | 2 +- CRM/Event/Form/Registration/Register.php | 16 ++--- CRM/Financial/BAO/ExportFormat.php | 8 ++- CRM/Financial/BAO/ExportFormat/CSV.php | 1 - CRM/Financial/BAO/ExportFormat/IIF.php | 9 +-- CRM/Financial/BAO/FinancialAccount.php | 1 - CRM/Financial/BAO/FinancialType.php | 1 - CRM/Financial/Form/FinancialType.php | 1 - CRM/Financial/Page/AJAX.php | 7 +-- CRM/Grant/BAO/Query.php | 1 - CRM/Grant/Form/Search.php | 6 +- CRM/Logging/Schema.php | 7 +-- CRM/Mailing/Form/Browse.php | 1 - CRM/Mailing/Form/Subscribe.php | 1 - CRM/Mailing/Page/Browse.php | 1 - CRM/Mailing/Page/Event.php | 1 - CRM/Member/Form/Membership.php | 44 +++++++++----- CRM/Member/Form/MembershipRenewal.php | 59 ++++++++++++------- CRM/Member/Form/Search.php | 6 +- CRM/Member/Form/Task/Batch.php | 4 +- CRM/PCP/BAO/PCP.php | 10 ++-- CRM/Pledge/BAO/Query.php | 1 - CRM/Price/BAO/PriceSet.php | 8 ++- CRM/Profile/Page/Listings.php | 1 - CRM/Queue/Menu.php | 1 - CRM/Report/BAO/ReportInstance.php | 1 - CRM/Report/Config.php | 1 - CRM/Report/Form/ActivitySummary.php | 1 - CRM/Report/Form/Case/Demographics.php | 1 - CRM/Report/Form/Case/Detail.php | 1 - CRM/Report/Form/Case/Summary.php | 1 - CRM/Report/Form/Case/TimeSpent.php | 1 - CRM/Report/Form/Contact/CurrentEmployer.php | 1 - CRM/Report/Form/Contact/Log.php | 1 - CRM/Report/Form/Contact/LoggingDetail.php | 1 - CRM/Report/Form/Contact/Relationship.php | 1 - CRM/Report/Form/Contact/Summary.php | 1 - CRM/Report/Form/Contribute/Bookkeeping.php | 1 - CRM/Report/Form/Contribute/History.php | 1 - .../Form/Contribute/HouseholdSummary.php | 1 - CRM/Report/Form/Contribute/LoggingDetail.php | 1 - CRM/Report/Form/Contribute/LoggingSummary.php | 1 - .../Form/Contribute/OrganizationSummary.php | 1 - CRM/Report/Form/Contribute/PCP.php | 1 - CRM/Report/Form/Contribute/Repeat.php | 1 - CRM/Report/Form/Contribute/TopDonor.php | 1 - CRM/Report/Form/Event.php | 1 - CRM/Report/Form/Event/Income.php | 1 - CRM/Report/Form/Event/IncomeCountSummary.php | 1 - .../Form/Event/ParticipantListCount.php | 1 - CRM/Report/Form/Event/ParticipantListing.php | 1 - CRM/Report/Form/Event/Summary.php | 1 - CRM/Report/Form/Grant/Detail.php | 1 - CRM/Report/Form/Grant/Statistics.php | 1 - CRM/Report/Form/Mailing/Bounce.php | 1 - CRM/Report/Form/Mailing/Clicks.php | 1 - CRM/Report/Form/Mailing/Detail.php | 1 - CRM/Report/Form/Mailing/Opened.php | 1 - CRM/Report/Form/Mailing/Summary.php | 1 - CRM/Report/Form/Member/ContributionDetail.php | 1 - CRM/Report/Form/Membership/Summary.php | 1 - CRM/Report/Form/Pledge/Detail.php | 6 +- CRM/Report/Form/Pledge/Summary.php | 1 - CRM/Report/Form/Register.php | 1 - CRM/Report/Form/Walklist/Walklist.php | 1 - CRM/Report/Interface.php | 1 - CRM/Report/Page/Instance.php | 1 - CRM/Report/Page/InstanceList.php | 1 - CRM/Report/Page/Options.php | 1 - CRM/Report/Page/Report.php | 1 - CRM/Report/Page/TemplateList.php | 1 - CRM/Report/Utils/Get.php | 1 - CRM/Report/Utils/Report.php | 1 - CRM/SMS/BAO/Provider.php | 5 +- CRM/Upgrade/Incremental/php/FourOne.php | 1 - CRM/Upgrade/Incremental/php/FourThree.php | 1 - CRM/Upgrade/Incremental/php/FourTwo.php | 1 - CRM/Upgrade/Incremental/php/FourZero.php | 1 - CRM/Upgrade/Incremental/php/ThreeThree.php | 1 - CRM/Utils/Array.php | 9 +-- CRM/Utils/Hook/Drupal.php | 1 - CRM/Utils/Hook/Joomla.php | 1 - CRM/Utils/Hook/Soap.php | 1 - CRM/Utils/Hook/UnitTests.php | 1 - CRM/Utils/JS.php | 1 - CRM/Utils/PDF/Label.php | 17 +++--- CRM/Utils/PDF/Utils.php | 5 +- CRM/Utils/PseudoConstant.php | 2 +- CRM/Utils/QueryFormatter.php | 1 - CRM/Utils/Recent.php | 1 - CRM/Utils/System.php | 7 +-- CRM/Utils/System/Drupal.php | 24 +++----- CRM/Utils/System/Drupal6.php | 12 ++-- api/api.php | 2 +- api/v3/Acl.php | 1 - api/v3/AclRole.php | 1 - api/v3/ActionSchedule.php | 1 - api/v3/ActivityContact.php | 1 - api/v3/Address.php | 1 - api/v3/Attachment.php | 1 - api/v3/Batch.php | 1 - api/v3/Campaign.php | 1 - api/v3/Case.php | 1 - api/v3/Constant.php | 1 - api/v3/ContactType.php | 1 - api/v3/Contribution.php | 1 - api/v3/ContributionPage.php | 1 - api/v3/CustomField.php | 1 - api/v3/CustomGroup.php | 1 - api/v3/CustomValue.php | 1 - api/v3/DashboardContact.php | 1 - api/v3/Domain.php | 1 - api/v3/Email.php | 1 - api/v3/EntityTag.php | 1 - api/v3/Event.php | 1 - api/v3/File.php | 1 - api/v3/FinancialAccount.php | 1 - api/v3/FinancialType.php | 1 - api/v3/Generic/Getactions.php | 1 - api/v3/Generic/Getlist.php | 1 - api/v3/Generic/Update.php | 1 - api/v3/Grant.php | 1 - api/v3/Group.php | 1 - api/v3/GroupNesting.php | 1 - api/v3/GroupOrganization.php | 1 - api/v3/LineItem.php | 1 - api/v3/LocBlock.php | 1 - api/v3/LocationType.php | 1 - api/v3/MailSettings.php | 1 - api/v3/Mailing.php | 1 - api/v3/MailingAB.php | 1 - api/v3/MailingComponent.php | 1 - api/v3/MailingEventConfirm.php | 1 - api/v3/MailingEventResubscribe.php | 1 - api/v3/MailingEventSubscribe.php | 1 - api/v3/MailingEventUnsubscribe.php | 1 - api/v3/MailingGroup.php | 1 - api/v3/MailingJob.php | 1 - api/v3/MailingRecipients.php | 1 - api/v3/Membership.php | 1 - api/v3/MembershipBlock.php | 1 - api/v3/MembershipPayment.php | 1 - api/v3/MembershipStatus.php | 1 - api/v3/MembershipType.php | 1 - api/v3/MessageTemplate.php | 1 - api/v3/Note.php | 1 - api/v3/Participant.php | 1 - api/v3/ParticipantPayment.php | 1 - api/v3/ParticipantStatusType.php | 1 - api/v3/PaymentProcessorType.php | 1 - api/v3/Phone.php | 1 - api/v3/Pledge.php | 1 - api/v3/PledgePayment.php | 1 - api/v3/Premium.php | 1 - api/v3/PriceField.php | 1 - api/v3/PriceFieldValue.php | 1 - api/v3/PriceSet.php | 1 - api/v3/PrintLabel.php | 1 - api/v3/Product.php | 1 - api/v3/Profile.php | 1 - api/v3/Relationship.php | 1 - api/v3/SmsProvider.php | 1 - api/v3/Survey.php | 1 - api/v3/SurveyRespondant.php | 1 - api/v3/System.php | 1 - api/v3/SystemLog.php | 1 - api/v3/UFField.php | 1 - api/v3/UFGroup.php | 1 - api/v3/UFJoin.php | 1 - api/v3/UFMatch.php | 1 - api/v3/Website.php | 1 - api/v3/WordReplacement.php | 1 - .../CRM/Core/CommunityMessagesTest.php | 1 - .../Contribute/OfflineContributionTest.php | 1 - .../Financial/FinancialAccountTest.php | 1 - .../Financial/FinancialAccountTypeTest.php | 1 - .../WebTest/Import/DuplicateMatchingTest.php | 7 +-- .../Import/MultipleRelationshipTest.php | 12 ++-- tests/phpunit/WebTest/Import/TagTest.php | 6 +- .../Member/InheritedMembershipTest.php | 2 +- .../Report/RolePermissionReportTest.php | 2 +- tests/phpunit/api/v3/ACLCachingTest.php | 1 - tests/phpunit/api/v3/APITest.php | 6 +- tests/phpunit/api/v3/ActivityTest.php | 8 +-- tests/phpunit/api/v3/ContactTest.php | 26 ++++---- tests/phpunit/api/v3/ContributionSoftTest.php | 2 +- tests/phpunit/api/v3/ContributionTest.php | 4 +- tests/phpunit/api/v3/EventTest.php | 1 - tests/phpunit/api/v3/GroupContactTest.php | 1 - tests/phpunit/api/v3/MailSettingsTest.php | 1 - .../phpunit/api/v3/MembershipPaymentTest.php | 1 - tests/phpunit/api/v3/MembershipTypeTest.php | 1 - .../api/v3/ParticipantStatusTypeTest.php | 1 - tests/phpunit/api/v3/PledgeTest.php | 4 +- tests/phpunit/api/v3/PriceFieldValueTest.php | 1 - tests/phpunit/api/v3/PriceSetTest.php | 1 - tests/phpunit/api/v3/ProfileTest.php | 1 - tests/phpunit/api/v3/RelationshipTypeTest.php | 1 - .../api/v3/TaxContributionPageTest.php | 1 - 245 files changed, 269 insertions(+), 528 deletions(-) diff --git a/CRM/ACL/Form/WordPress/Permissions.php b/CRM/ACL/Form/WordPress/Permissions.php index f4c3e14fd0..489bd60757 100644 --- a/CRM/ACL/Form/WordPress/Permissions.php +++ b/CRM/ACL/Form/WordPress/Permissions.php @@ -1,5 +1,4 @@ _where[$grouping][] = $groupClause; $this->_qill[$grouping][] = $qill; } - /* - * Function translates selection of group type into a list of groups - */ + /** + * Function translates selection of group type into a list of groups * @param $value * * @return array diff --git a/CRM/Contact/Form/Domain.php b/CRM/Contact/Form/Domain.php index 124ca0f8b1..e61db3fbd5 100644 --- a/CRM/Contact/Form/Domain.php +++ b/CRM/Contact/Form/Domain.php @@ -90,23 +90,14 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { $location->preProcess($this); } - /* - * Set default values for the form. - * the default values are retrieved from the database - * - * @return void - */ /** * This virtual function is used to set the default values of * various form elements * - * access public - * * @return array * reference to the array of default values - */ - /** - * @return array + * + * @access public */ public function setDefaultValues() { $defaults = array(); diff --git a/CRM/Contact/Form/Search.php b/CRM/Contact/Form/Search.php index 30df4e6823..e733553e70 100644 --- a/CRM/Contact/Form/Search.php +++ b/CRM/Contact/Form/Search.php @@ -43,7 +43,7 @@ */ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { - /* + /** * list of valid contexts * * @var array diff --git a/CRM/Contact/Form/Search/Basic.php b/CRM/Contact/Form/Search/Basic.php index 13dd608ef7..fdce0fb1fb 100644 --- a/CRM/Contact/Form/Search/Basic.php +++ b/CRM/Contact/Form/Search/Basic.php @@ -43,7 +43,7 @@ */ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { - /* + /** * csv - common search values * * @var array diff --git a/CRM/Contact/Form/Search/Custom/Group.php b/CRM/Contact/Form/Search/Custom/Group.php index e7dd79ec04..53ebf0e47b 100644 --- a/CRM/Contact/Form/Search/Custom/Group.php +++ b/CRM/Contact/Form/Search/Custom/Group.php @@ -154,10 +154,8 @@ class CRM_Contact_Form_Search_Custom_Group $form->assign('elements', array('includeGroups', 'excludeGroups', 'andOr', 'includeTags', 'excludeTags')); } - /* - * Set search form field defaults here. - */ /** + * Set search form field defaults here. * @return array */ public function setDefaultValues() { diff --git a/CRM/Contact/Form/Task/AddToGroup.php b/CRM/Contact/Form/Task/AddToGroup.php index 976ab1694f..7430df1926 100644 --- a/CRM/Contact/Form/Task/AddToGroup.php +++ b/CRM/Contact/Form/Task/AddToGroup.php @@ -67,9 +67,7 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { * @return void */ public function preProcess() { - /* - * initialize the task and row fields - */ + // initialize the task and row fields parent::preProcess(); $this->_context = $this->get('context'); diff --git a/CRM/Contact/Form/Task/AddToHousehold.php b/CRM/Contact/Form/Task/AddToHousehold.php index c4c11ed02d..cad57bfc0b 100644 --- a/CRM/Contact/Form/Task/AddToHousehold.php +++ b/CRM/Contact/Form/Task/AddToHousehold.php @@ -45,10 +45,7 @@ class CRM_Contact_Form_Task_AddToHousehold extends CRM_Contact_Form_Task { * @return void */ public function preProcess() { - /* - * initialize the task and row fields - */ - + // initialize the task and row fields parent::preProcess(); } diff --git a/CRM/Contact/Form/Task/Batch.php b/CRM/Contact/Form/Task/Batch.php index cb53f82820..13789d7dd0 100644 --- a/CRM/Contact/Form/Task/Batch.php +++ b/CRM/Contact/Form/Task/Batch.php @@ -71,9 +71,7 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { * @return void */ public function preProcess() { - /* - * initialize the task and row fields - */ + // initialize the task and row fields parent::preProcess(); } diff --git a/CRM/Contact/Form/Task/PickProfile.php b/CRM/Contact/Form/Task/PickProfile.php index b2cc75dfb4..6cc7c4c171 100644 --- a/CRM/Contact/Form/Task/PickProfile.php +++ b/CRM/Contact/Form/Task/PickProfile.php @@ -66,9 +66,7 @@ class CRM_Contact_Form_Task_PickProfile extends CRM_Contact_Form_Task { * @return void */ public function preProcess() { - /* - * initialize the task and row fields - */ + // initialize the task and row fields parent::preProcess(); $session = CRM_Core_Session::singleton(); diff --git a/CRM/Contact/Form/Task/ProximityCommon.php b/CRM/Contact/Form/Task/ProximityCommon.php index f44e083f6d..ff829546d9 100644 --- a/CRM/Contact/Form/Task/ProximityCommon.php +++ b/CRM/Contact/Form/Task/ProximityCommon.php @@ -65,9 +65,7 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { * @return void */ public function preProcess() { - /* - * initialize the task and row fields - */ + // initialize the task and row fields parent::preProcess(); } diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index fe7480a10e..396194b45f 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -66,9 +66,6 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution { */ public $_component = NULL; - /* - * construct method - */ /** * Class constructor * @@ -3241,20 +3238,15 @@ WHERE contribution_id = %1 "; } - /* + /** * Function to record additional payment for partial and refund contributions * * @param int $contributionId * is the invoice contribution id (got created after processing participant payment). - * @param array $trxnData + * @param array $trxnsData * to take user provided input of transaction details. * @param string $paymentType * 'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments. - */ - /** - * @param int $contributionId - * @param $trxnsData - * @param string $paymentType * @param int $participantId * * @return null|object diff --git a/CRM/Contribute/BAO/ContributionSoft.php b/CRM/Contribute/BAO/ContributionSoft.php index 03f443f54c..908c939f1a 100644 --- a/CRM/Contribute/BAO/ContributionSoft.php +++ b/CRM/Contribute/BAO/ContributionSoft.php @@ -311,15 +311,11 @@ class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_Contributio return $result; } - /* - * Function to assign honor profile fields to template/form, if $honorId (as soft-credit's contact_id) - * is passed then whole honoreeprofile fields with title/value assoc array assigned or only honoreeName - * is assigned - * - * @static - */ - /** + * Function to assign honor profile fields to template/form, if $honorId (as soft-credit's contact_id) + * is passed then whole honoreeprofile fields with title/value assoc array assigned or only honoreeName + * is assigned + * * @param CRM_Core_Form $form * @param array $params * @param int $honoreeprofileId diff --git a/CRM/Contribute/Form/AbstractEditPayment.php b/CRM/Contribute/Form/AbstractEditPayment.php index b7ed01b83e..164b49adf2 100644 --- a/CRM/Contribute/Form/AbstractEditPayment.php +++ b/CRM/Contribute/Form/AbstractEditPayment.php @@ -158,7 +158,7 @@ class CRM_Contribute_Form_AbstractEditPayment extends CRM_Core_Form { public $_compId; - /* + /** * Store the line items if price set used. */ public $_lineItems; diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php index ba2456d79d..74e4d44c5d 100644 --- a/CRM/Contribute/Form/Contribution.php +++ b/CRM/Contribute/Form/Contribution.php @@ -148,7 +148,8 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP * @var integer */ public $fromEmailId; - /* + + /** * Store the line items if price set used. */ public $_lineItems; diff --git a/CRM/Contribute/Form/Task/Batch.php b/CRM/Contribute/Form/Task/Batch.php index c193d2cdbd..a4193d0038 100644 --- a/CRM/Contribute/Form/Task/Batch.php +++ b/CRM/Contribute/Form/Task/Batch.php @@ -61,9 +61,7 @@ class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task { * @return void */ public function preProcess() { - /* - * initialize the task and row fields - */ + // initialize the task and row fields parent::preProcess(); //get the contact read only fields to display. diff --git a/CRM/Contribute/Form/Task/PickProfile.php b/CRM/Contribute/Form/Task/PickProfile.php index 351022604c..b89a96adda 100644 --- a/CRM/Contribute/Form/Task/PickProfile.php +++ b/CRM/Contribute/Form/Task/PickProfile.php @@ -61,9 +61,7 @@ class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task { * @return void */ public function preProcess() { - /* - * initialize the task and row fields - */ + // initialize the task and row fields parent::preProcess(); $session = CRM_Core_Session::singleton(); $this->_userContext = $session->readUserContext(); diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php index e1753e6d79..014298563f 100644 --- a/CRM/Core/BAO/Block.php +++ b/CRM/Core/BAO/Block.php @@ -421,9 +421,8 @@ class CRM_Core_BAO_Block { $block = new $baoString(); $block->copyValues($params); - /* - * CRM-11006 add call to pre and post hook for delete action - */ + + // CRM-11006 add call to pre and post hook for delete action CRM_Utils_Hook::pre('delete', $name, $block->id, CRM_Core_DAO::$_nullArray); $block->delete(); CRM_Utils_Hook::post('delete', $name, $block->id, $block); diff --git a/CRM/Core/BAO/CustomQuery.php b/CRM/Core/BAO/CustomQuery.php index 35fee5df4c..bb656e8b1a 100644 --- a/CRM/Core/BAO/CustomQuery.php +++ b/CRM/Core/BAO/CustomQuery.php @@ -1,5 +1,4 @@ amount - * payment type : 'amount_owed' or 'refund_due' - */ /** + * get partial payment amount and type of it + * * @param int $entityId * @param string $entityName * @param bool $returnType - * @param NULL $lineItemTotal + * @param number $lineItemTotal * * @return array|int|NULL|string + * [payment type => amount] + * payment type: 'amount_owed' or 'refund_due' */ public static function getPartialPaymentWithType($entityId, $entityName = 'participant', $returnType = TRUE, $lineItemTotal = NULL) { $value = NULL; diff --git a/CRM/Core/BAO/LocationType.php b/CRM/Core/BAO/LocationType.php index 0a8bea79b3..268c94286b 100644 --- a/CRM/Core/BAO/LocationType.php +++ b/CRM/Core/BAO/LocationType.php @@ -105,13 +105,11 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { return self::$_defaultLocationType; } - /* + /** * Get ID of billing location type + * * @return int */ - /** - * @return mixed|null - */ public static function getBilling() { if (self::$_billingLocationType == NULL) { $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id', array(), 'validate'); diff --git a/CRM/Core/BAO/Phone.php b/CRM/Core/BAO/Phone.php index e36771c5da..68965acca8 100644 --- a/CRM/Core/BAO/Phone.php +++ b/CRM/Core/BAO/Phone.php @@ -38,14 +38,10 @@ */ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { - /* + /** * Create phone object - note that the create function calls 'add' but * has more business logic * - * @param array $params - * Input parameters. - */ - /** * @param array $params * * @return object diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php index 6c2cb5476f..bd215c4002 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -38,15 +38,8 @@ */ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch { - /* - * Create UF Match, Note that thsi function is here in it's simplest form @ the moment - * - * - * @param array $params - * Input parameters. - */ /** - * @param array $params + * Create UF Match, Note that thsi function is here in it's simplest form @ the moment * * @return CRM_Core_DAO_UFMatch */ diff --git a/CRM/Core/Component/Info.php b/CRM/Core/Component/Info.php index a7548f46fc..6100cedd0b 100644 --- a/CRM/Core/Component/Info.php +++ b/CRM/Core/Component/Info.php @@ -90,7 +90,7 @@ abstract class CRM_Core_Component_Info { */ public $info; - /* + /** * Stores component keyword * @var string name of component keyword */ diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 76bb21db1b..aa29909f07 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -63,9 +63,10 @@ class CRM_Core_DAO extends DB_DataObject { QUERY_FORMAT_WILDCARD = 1, QUERY_FORMAT_NO_QUOTES = 2; - /* + /** * Define entities that shouldn't be created or deleted when creating/ deleting - * test objects - this prevents world regions, countries etc from being added / deleted + * test objects - this prevents world regions, countries etc from being added / deleted + * @var array */ static $_testEntitiesToSkip = array(); /** diff --git a/CRM/Core/DAO/permissions.php b/CRM/Core/DAO/permissions.php index 207d0d3b7d..4ce8d00a11 100644 --- a/CRM/Core/DAO/permissions.php +++ b/CRM/Core/DAO/permissions.php @@ -1,5 +1,4 @@ fatalErrorHandler = 'CRM_Core_JobManager_scheduledJobFatalErrorHandler'; @@ -65,10 +63,6 @@ class CRM_Core_JobManager { $this->jobs = $this->_getJobs(); } - /* - * - * @param void - */ /** * @param bool $auth */ @@ -93,10 +87,8 @@ class CRM_Core_JobManager { $this->logEntry('Finishing scheduled jobs execution.'); } - /* + /** * Class destructor - * - * @param void */ public function __destruct() { } @@ -145,17 +137,13 @@ class CRM_Core_JobManager { $this->currentJob = FALSE; } - /* + /** * Retrieves the list of jobs from the database, * populates class param. * - * @param void * @return array * ($id => CRM_Core_ScheduledJob) */ - /** - * @return array - */ private function _getJobs() { $jobs = array(); $dao = new CRM_Core_DAO_Job(); @@ -170,13 +158,10 @@ class CRM_Core_JobManager { return $jobs; } - /* + /** * Retrieves specific job from the database by id * and creates ScheduledJob object. * - * @param void - */ - /** * @param int $id * @param null $entity * @param null $action @@ -213,14 +198,12 @@ class CRM_Core_JobManager { $this->singleRunParams[$key]['version'] = 3; } - /* + /** + * @param string $message * * @return array|null * collection of permissions, null if none */ - /** - * @param $message - */ public function logEntry($message) { $domainID = CRM_Core_Config::domainID(); $dao = new CRM_Core_DAO_JobLog(); diff --git a/CRM/Core/OptionGroup.php b/CRM/Core/OptionGroup.php index 6c4eeef754..ff6037dcab 100644 --- a/CRM/Core/OptionGroup.php +++ b/CRM/Core/OptionGroup.php @@ -36,7 +36,7 @@ class CRM_Core_OptionGroup { static $_values = array(); static $_cache = array(); - /* + /** * $_domainIDGroups array maintains the list of option groups for whom * domainID is to be considered. */ @@ -639,7 +639,7 @@ WHERE v.option_group_id = g.id return $row; } - /* + /** * Wrapper for calling values with fresh set to true to empty the given value * * Since there appears to be some inconsistency @@ -647,9 +647,8 @@ WHERE v.option_group_id = g.id * (for example CRM_Contribution_Pseudoconstant::paymentInstrument doesn't specify isActive * which is part of the cache key * will do a couple of variations & aspire to someone cleaning it up later - */ - /** - * @param $name + * + * @param string $name * @param array $params */ public static function flush($name, $params = array()) { diff --git a/CRM/Core/Page/AJAX/RecurringEntity.php b/CRM/Core/Page/AJAX/RecurringEntity.php index 259d2825f2..b3547c3178 100644 --- a/CRM/Core/Page/AJAX/RecurringEntity.php +++ b/CRM/Core/Page/AJAX/RecurringEntity.php @@ -1,5 +1,4 @@ fields(); $key = ''; if (!empty($fields['title'])) { diff --git a/CRM/Core/Page/Inline/Help.php b/CRM/Core/Page/Inline/Help.php index 3b9efa5b0c..4bab317910 100644 --- a/CRM/Core/Page/Inline/Help.php +++ b/CRM/Core/Page/Inline/Help.php @@ -1,5 +1,4 @@ _processorName = ts('PayJunction'); } - /* + /** * This function sends request and receives response from * PayJunction payment process - */ - /** - * This function collects all the information from a web/api form and invokes - * the relevant payment processor specific functions to perform the transaction * * @param array $params * Assoc array of input parameters for this transaction. * * @return array * the result in an nice formatted array (or an error object) - * @abstract */ public function doDirectPayment(&$params) { $logon = $this->_paymentProcessor['user_name']; @@ -178,11 +173,8 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { // end function doDirectPayment - /* - * This function checks the PayJunction response code - */ /** - * @param $response + * This function checks the PayJunction response code * * @return bool */ diff --git a/CRM/Core/Payment/PaymentExpress.php b/CRM/Core/Payment/PaymentExpress.php index ee7f4b59dc..f4ef133eec 100644 --- a/CRM/Core/Payment/PaymentExpress.php +++ b/CRM/Core/Payment/PaymentExpress.php @@ -171,12 +171,12 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { } /* - * Build the private data string to pass to DPS, which they will give back to us with the - * - * transaction result. We are building this as a comma-separated list so as to avoid long URLs. - * - * Parameters passed: a=contactID, b=contributionID,c=contributionTypeID,d=invoiceID,e=membershipID,f=participantID,g=eventID - */ + * Build the private data string to pass to DPS, which they will give back to us with the + * + * transaction result. We are building this as a comma-separated list so as to avoid long URLs. + * + * Parameters passed: a=contactID, b=contributionID,c=contributionTypeID,d=invoiceID,e=membershipID,f=participantID,g=eventID + */ $privateData = "a={$params['contactID']},b={$params['contributionID']},c={$params['contributionTypeID']},d={$params['invoiceID']}"; @@ -210,8 +210,8 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { CRM_Utils_Hook::alterPaymentProcessorParams($this, $params, $dpsParams); /* - * determine whether method is pxaccess or pxpay by whether signature (mac key) is defined - */ + * determine whether method is pxaccess or pxpay by whether signature (mac key) is defined + */ if (empty($this->_paymentProcessor['signature'])) { /* diff --git a/CRM/Core/Payment/PaymentExpressIPN.php b/CRM/Core/Payment/PaymentExpressIPN.php index 021755c4c5..a6ae745f95 100644 --- a/CRM/Core/Payment/PaymentExpressIPN.php +++ b/CRM/Core/Payment/PaymentExpressIPN.php @@ -25,13 +25,13 @@ /* - * PxPay Functionality Copyright (C) 2008 Lucas Baker, Logistic Information Systems Limited (Logis) - * PxAccess Functionality Copyright (C) 2008 Eileen McNaughton - * Licensed to CiviCRM under the Academic Free License version 3.0. - * - * Grateful acknowledgements go to Donald Lobo for invaluable assistance - * in creating this payment processor module - */ + * PxPay Functionality Copyright (C) 2008 Lucas Baker, Logistic Information Systems Limited (Logis) + * PxAccess Functionality Copyright (C) 2008 Eileen McNaughton + * Licensed to CiviCRM under the Academic Free License version 3.0. + * + * Grateful acknowledgements go to Donald Lobo for invaluable assistance + * in creating this payment processor module + */ /** * Class CRM_Core_Payment_PaymentExpressIPN diff --git a/CRM/Core/Payment/Realex.php b/CRM/Core/Payment/Realex.php index 24ba592571..dd79992808 100644 --- a/CRM/Core/Payment/Realex.php +++ b/CRM/Core/Payment/Realex.php @@ -25,11 +25,11 @@ /* - * Copyright (C) 2009 - * Licensed to CiviCRM under the Academic Free License version 3.0. - * - * Written and contributed by Kirkdesigns (http://www.kirkdesigns.co.uk) - */ + * Copyright (C) 2009 + * Licensed to CiviCRM under the Academic Free License version 3.0. + * + * Written and contributed by Kirkdesigns (http://www.kirkdesigns.co.uk) + */ /** * diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php index 6e127276a8..34eded7d3e 100644 --- a/CRM/Core/PseudoConstant.php +++ b/CRM/Core/PseudoConstant.php @@ -981,10 +981,8 @@ WHERE id = %1"; */ public static function &groupIterator($styledLabels = FALSE) { if (!self::$groupIterator) { - /* - When used as an object, GroupNesting implements Iterator - and iterates nested groups in a logical manner for us - */ + // When used as an object, GroupNesting implements Iterator + // and iterates nested groups in a logical manner for us self::$groupIterator = new CRM_Contact_BAO_GroupNesting($styledLabels); } return self::$groupIterator; diff --git a/CRM/Core/TableHierarchy.php b/CRM/Core/TableHierarchy.php index dc07c38908..249f522124 100644 --- a/CRM/Core/TableHierarchy.php +++ b/CRM/Core/TableHierarchy.php @@ -1,5 +1,4 @@ defaults = array(); /* - * we allow the controller to set force/reset externally, useful when we are being - * driven by the wizard framework - */ + * we allow the controller to set force/reset externally, useful when we are being + * driven by the wizard framework + */ $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean', CRM_Core_DAO::$_nullObject); $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE); diff --git a/CRM/Logging/Schema.php b/CRM/Logging/Schema.php index 3810315f2e..ae27e5818b 100644 --- a/CRM/Logging/Schema.php +++ b/CRM/Logging/Schema.php @@ -313,12 +313,11 @@ AND TABLE_NAME LIKE 'log_civicrm_%' } } - /* - * log_civicrm_contact.modified_date for example would always be copied from civicrm_contact.modified_date, + /** + * Log_civicrm_contact.modified_date for example would always be copied from civicrm_contact.modified_date, * so there's no need for a default timestamp and therefore we remove such default timestamps * also eliminate the NOT NULL constraint, since we always copy and schema can change down the road) - */ - /** + * * @param $query * * @return mixed diff --git a/CRM/Mailing/Form/Browse.php b/CRM/Mailing/Form/Browse.php index e595705024..43e33a2e28 100644 --- a/CRM/Mailing/Form/Browse.php +++ b/CRM/Mailing/Form/Browse.php @@ -1,5 +1,4 @@ defaults = array(); /* - * we allow the controller to set force/reset externally, useful when we are being - * driven by the wizard framework - */ + * we allow the controller to set force/reset externally, useful when we are being + * driven by the wizard framework + */ $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean', CRM_Core_DAO::$_nullObject); $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE); diff --git a/CRM/Member/Form/Task/Batch.php b/CRM/Member/Form/Task/Batch.php index 3307a7366e..d6552097c4 100644 --- a/CRM/Member/Form/Task/Batch.php +++ b/CRM/Member/Form/Task/Batch.php @@ -61,9 +61,7 @@ class CRM_Member_Form_Task_Batch extends CRM_Member_Form_Task { * @return void */ public function preProcess() { - /* - * initialize the task and row fields - */ + // initialize the task and row fields parent::preProcess(); //get the contact read only fields to display. diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php index 18d4108a1f..64f8c9615e 100644 --- a/CRM/PCP/BAO/PCP.php +++ b/CRM/PCP/BAO/PCP.php @@ -428,10 +428,9 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } - /* - * Add PCP form elements to a form - */ /** + * Add PCP form elements to a form + * * @param int $pcpId * @param CRM_Core_Page $page * @param null $elements @@ -481,10 +480,9 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; } } - /* - * Process a PCP contribution/ - */ /** + * Process a PCP contribution + * * @param int $pcpId * @param $component * @param $entity diff --git a/CRM/Pledge/BAO/Query.php b/CRM/Pledge/BAO/Query.php index 273e59e465..762f262446 100644 --- a/CRM/Pledge/BAO/Query.php +++ b/CRM/Pledge/BAO/Query.php @@ -1,5 +1,4 @@ paper_dimensions = array($w, $h); } - /* - * Generate the pdf of one label (can be modified using SetGenerator) - */ /** - * @param $text + * Generate the pdf of one label (can be modified using SetGenerator) + * + * @param string $text */ public function generateLabel($text) { $args = array( @@ -229,10 +227,9 @@ class CRM_Utils_PDF_Label extends TCPDF { } } - /* - * Print a label - */ /** + * Print a label + * * @param $texte */ public function AddPdfLabel($texte) { diff --git a/CRM/Utils/PDF/Utils.php b/CRM/Utils/PDF/Utils.php index b60466e4d2..1e97062f90 100644 --- a/CRM/Utils/PDF/Utils.php +++ b/CRM/Utils/PDF/Utils.php @@ -224,10 +224,9 @@ class CRM_Utils_PDF_Utils { } } - /* - * convert value from one metric to another - */ /** + * convert value from one metric to another + * * @param $value * @param $from * @param $to diff --git a/CRM/Utils/PseudoConstant.php b/CRM/Utils/PseudoConstant.php index 143d79bbc9..8aee0d5dce 100644 --- a/CRM/Utils/PseudoConstant.php +++ b/CRM/Utils/PseudoConstant.php @@ -29,7 +29,7 @@ * Utilities for manipulating/inspecting CRM_*_PseudoConstant classes */ class CRM_Utils_PseudoConstant { - /* + /** * CiviCRM pseudoconstant classes for wrapper functions */ private static $constantClasses = array( diff --git a/CRM/Utils/QueryFormatter.php b/CRM/Utils/QueryFormatter.php index 1404ede2ea..a3577ab5da 100644 --- a/CRM/Utils/QueryFormatter.php +++ b/CRM/Utils/QueryFormatter.php @@ -1,5 +1,4 @@ uid; } - /* - * Change user name in host CMS - * - * @param int $ufID User ID in CMS - * @param string $ufName User name - */ /** + * Change user name in host CMS + * * @param int $ufID + * User ID in CMS * @param string $ufName + * User name */ public function updateCMSName($ufID, $ufName) { // CRM-5555 @@ -176,19 +174,14 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { } } - /* + /** * Get the drupal destination string. When this is passed in the * URL the user will be directed to it after filling in the drupal form * * @param CRM_Core_Form $form * Form object representing the 'current' form - to which the user will be returned. - * @return string - * destination value for URL - */ - /** - * @param CRM_Core_Form $form - * * @return null|string + * destination value for URL */ public function getLoginDestination(&$form) { $args = NULL; @@ -538,10 +531,9 @@ AND u.status = 1 return FALSE; } - /* - * Load user into session - */ /** + * Load user into session + * * @param string $username * * @return bool diff --git a/CRM/Utils/System/Drupal6.php b/CRM/Utils/System/Drupal6.php index 35472c9d42..1d2cf0fdd7 100644 --- a/CRM/Utils/System/Drupal6.php +++ b/CRM/Utils/System/Drupal6.php @@ -121,15 +121,11 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { return $form_state['user']->uid; } - /* - * Change user name in host CMS - * - * @param int $ufID User ID in CMS - * @param string $ufName User name - */ /** - * @param int $ufID - * @param string $ufName + * Change user name in host CMS + * + * @param int $ufID User ID in CMS + * @param string $ufName User name */ public function updateCMSName($ufID, $ufName) { // CRM-5555 diff --git a/api/api.php b/api/api.php index 4135224dac..b88dc5b278 100644 --- a/api/api.php +++ b/api/api.php @@ -117,7 +117,7 @@ function _civicrm_api_get_camel_name($entity) { * 'activity_type_id' => '$value.testfield', * 'tag_id' => '$value.api.tag.create.id', * 'tag1_id' => '$value.api.entity.create.0.id' - * + * * @param array $params * @param array $parentResult * @param string $separator diff --git a/api/v3/Acl.php b/api/v3/Acl.php index 39e3d7ee9d..f6eadc717d 100644 --- a/api/v3/Acl.php +++ b/api/v3/Acl.php @@ -1,5 +1,4 @@ webtestLogin(); @@ -48,12 +48,10 @@ class WebTest_Import_MultipleRelationshipTest extends ImportCiviSeleniumTestCase $this->importContacts($headers, $rows, 'Individual', 'Skip', $fieldMapper); } - /* + /** * Helper function to provide data for multiple relationship import * for Individuals. - - */ - /** + * * @return array */ public function _individualRelationshipCSVData() { diff --git a/tests/phpunit/WebTest/Import/TagTest.php b/tests/phpunit/WebTest/Import/TagTest.php index aade9ba15e..0ec43793b0 100644 --- a/tests/phpunit/WebTest/Import/TagTest.php +++ b/tests/phpunit/WebTest/Import/TagTest.php @@ -35,9 +35,9 @@ class WebTest_Import_TagTest extends ImportCiviSeleniumTestCase { parent::setUp(); } - /* - * Test contact import for Individuals. - */ + /** + * Test contact import for Individuals. + */ public function testContactImportWithTag() { $this->webtestLogin(); diff --git a/tests/phpunit/WebTest/Member/InheritedMembershipTest.php b/tests/phpunit/WebTest/Member/InheritedMembershipTest.php index 54c0f4edba..9508c9ca66 100644 --- a/tests/phpunit/WebTest/Member/InheritedMembershipTest.php +++ b/tests/phpunit/WebTest/Member/InheritedMembershipTest.php @@ -260,7 +260,7 @@ class WebTest_Member_InheritedMembershipTest extends CiviSeleniumTestCase { $this->waitForElementPresent('css=div#memberships'); } - /* + /** * Webtest for CRM-10146 */ public function testInheritedMembershipActivity() { diff --git a/tests/phpunit/WebTest/Report/RolePermissionReportTest.php b/tests/phpunit/WebTest/Report/RolePermissionReportTest.php index 0e928b8ce7..471f566f54 100644 --- a/tests/phpunit/WebTest/Report/RolePermissionReportTest.php +++ b/tests/phpunit/WebTest/Report/RolePermissionReportTest.php @@ -95,7 +95,7 @@ class WebTest_Report_RolePermissionReportTest extends CiviSeleniumTestCase { $this->_roleDelete($role2); } - /* + /** *check for CRM-10148 */ public function testReservedReportPermission() { diff --git a/tests/phpunit/api/v3/ACLCachingTest.php b/tests/phpunit/api/v3/ACLCachingTest.php index 8a7fc611db..28695e1077 100644 --- a/tests/phpunit/api/v3/ACLCachingTest.php +++ b/tests/phpunit/api/v3/ACLCachingTest.php @@ -1,5 +1,4 @@ assertEquals('krypton', $params['big_rock']); } - /* - * test that error doesn't occur for non-existant file - */ + /** + * test that error doesn't occur for non-existant file + */ public function testAPIWrapperIncludeNoFile() { $result = $this->callAPIFailure('RandomFile', 'get', array(), 'API (RandomFile,get) does not exist (join the API team and implement it!)'); diff --git a/tests/phpunit/api/v3/ActivityTest.php b/tests/phpunit/api/v3/ActivityTest.php index 3be599cc91..32e8ad6425 100644 --- a/tests/phpunit/api/v3/ActivityTest.php +++ b/tests/phpunit/api/v3/ActivityTest.php @@ -534,7 +534,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { $this->assertEquals("test activity type id", $result['values'][0]['subject'], 'In line ' . __LINE__); } - /* + /** * test that get functioning does filtering */ public function testGetFilter() { @@ -607,7 +607,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } } - /* + /** * test that get functioning does filtering */ public function testGetStatusID() { @@ -639,7 +639,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { } - /* + /** * test that get functioning does filtering */ public function testGetFilterMaxDate() { @@ -1112,7 +1112,7 @@ class api_v3_ActivityTest extends CiviUnitTestCase { $this->assertEquals('Test activity type', $result['values'][$activity2['id']]['activity_name'], 'In line ' . __LINE__); } - /* + /** * test chained Activity format */ public function testchainedActivityGet() { diff --git a/tests/phpunit/api/v3/ContactTest.php b/tests/phpunit/api/v3/ContactTest.php index 84fa9ffa2f..49904ca941 100644 --- a/tests/phpunit/api/v3/ContactTest.php +++ b/tests/phpunit/api/v3/ContactTest.php @@ -350,7 +350,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { } - /* + /** * Test creating a current employer through API */ public function testContactCreateCurrentEmployer() { @@ -385,10 +385,10 @@ class api_v3_ContactTest extends CiviUnitTestCase { } - /* + /** * Test creating a current employer through API * - check it will re-activate a de-activated employer - */ + */ public function testContactCreateDuplicateCurrentEmployerEnables() { //set up - create employer relationship $employerResult = $this->callAPISuccess('contact', 'create', array_merge($this->_params, array( @@ -465,10 +465,10 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->callAPISuccess($this->_entity, 'delete', array('id' => $c2['id'])); } - /* + /** * Test that we can retrieve contacts using * 'id' => array('IN' => array('3,4')) syntax - */ + */ public function testGetINIDArray() { $c1 = $this->callAPISuccess($this->_entity, 'create', $this->_params); $c2 = $this->callAPISuccess($this->_entity, 'create', array( @@ -489,7 +489,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->callAPISuccess($this->_entity, 'delete', array('id' => $c3['id'])); } - /* + /** * Test variants on deleted behaviour */ public function testGetDeleted() { @@ -1604,7 +1604,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->assertEquals('http://civicrm.org', $result['values'][$result['id']]['api.website.getValue']); } - /* + /** * Test checks siusage of $values to pick & choose inputs */ public function testChainingValuesCreate() { @@ -1629,7 +1629,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->quickCleanup($tablesToTruncate, TRUE); } - /* + /** * test TrueFalse format - I couldn't come up with an easy way to get an error on Get */ public function testContactGetFormatIsSuccessTrue() { @@ -1643,7 +1643,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->callAPISuccess('Contact', 'Delete', $params); } - /* + /** * test TrueFalse format */ public function testContactCreateFormatIsSuccessFalse() { @@ -1656,7 +1656,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->assertEquals(0, $result); } - /* + /** * test Single Entity format */ public function testContactGetSingle_entity_array() { @@ -1671,7 +1671,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->callAPISuccess('Contact', 'Delete', $params); } - /* + /** * test Single Entity format */ public function testContactGetFormatcount_only() { @@ -1685,7 +1685,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->callAPISuccess('Contact', 'Delete', $params); } - /* + /** * Test id only format */ public function testContactGetFormatID_only() { @@ -1700,7 +1700,7 @@ class api_v3_ContactTest extends CiviUnitTestCase { $this->callAPISuccess('Contact', 'Delete', $params); } - /* + /** * Test id only format */ public function testContactGetFormatSingleValue() { diff --git a/tests/phpunit/api/v3/ContributionSoftTest.php b/tests/phpunit/api/v3/ContributionSoftTest.php index da2b9b37b0..2bc8cf5dd9 100644 --- a/tests/phpunit/api/v3/ContributionSoftTest.php +++ b/tests/phpunit/api/v3/ContributionSoftTest.php @@ -196,7 +196,7 @@ class api_v3_ContributionSoftTest extends CiviUnitTestCase { ); } - /* + /** * Function tests that additional financial records are created when fee amount is recorded */ public function testCreateContributionSoft() { diff --git a/tests/phpunit/api/v3/ContributionTest.php b/tests/phpunit/api/v3/ContributionTest.php index d1734ba3df..3edd7f0272 100644 --- a/tests/phpunit/api/v3/ContributionTest.php +++ b/tests/phpunit/api/v3/ContributionTest.php @@ -518,9 +518,9 @@ class api_v3_ContributionTest extends CiviUnitTestCase { $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF'); } - /* + /** * Create test with unique field name on source - */ + */ public function testCreateDefaultNow() { $params = $this->_params; diff --git a/tests/phpunit/api/v3/EventTest.php b/tests/phpunit/api/v3/EventTest.php index 6e15818589..356aeac4ee 100644 --- a/tests/phpunit/api/v3/EventTest.php +++ b/tests/phpunit/api/v3/EventTest.php @@ -1,5 +1,4 @@ callAPISuccess('pledge', 'delete', array('pledge_id' => $pledge['id'])); } - /* + /** * Test that pledge with weekly schedule calculates dates correctly - */ + */ public function testCreatePledgeMontlySchedule() { $params = array( 'scheduled_date' => '20110510', diff --git a/tests/phpunit/api/v3/PriceFieldValueTest.php b/tests/phpunit/api/v3/PriceFieldValueTest.php index 34cf87e51b..5943d6b2e6 100644 --- a/tests/phpunit/api/v3/PriceFieldValueTest.php +++ b/tests/phpunit/api/v3/PriceFieldValueTest.php @@ -1,5 +1,4 @@