From 4f1f1f2a13f7d38ff984b04c7512617440bea5f8 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Sun, 11 Jan 2015 19:18:14 -0500 Subject: [PATCH] INFRA-132 - Move stray comments into docblocks --- CRM/Campaign/Form/Petition/Signature.php | 2 +- CRM/Campaign/Info.php | 15 +++++++-------- CRM/Case/Info.php | 16 ++++++++-------- CRM/Case/XMLProcessor/Settings.php | 4 ++-- .../Form/Search/Custom/ActivitySearch.php | 6 +++--- CRM/Contact/Form/Search/Custom/Base.php | 4 ++-- CRM/Contribute/Info.php | 14 +++++++------- CRM/Core/CodeGen/BaseTask.php | 7 ++++--- CRM/Core/Error.php | 10 +++++----- CRM/Core/Exception.php | 2 +- CRM/Core/Payment/BaseIPN.php | 8 ++++---- CRM/Core/Payment/Moneris.php | 2 +- CRM/Core/Payment/PayJunction.php | 2 +- CRM/Core/Payment/PayflowPro.php | 2 +- CRM/Core/Smarty/Permissions.php | 2 +- .../BAO/QueryBuilder/IndividualGeneral.php | 2 +- .../BAO/QueryBuilder/IndividualSupervised.php | 2 +- CRM/Dedupe/BAO/RuleGroup.php | 6 +++--- CRM/Dedupe/Merger.php | 6 +++--- CRM/Event/Cart/BAO/Conference.php | 4 ++-- CRM/Event/Cart/BAO/MerParticipant.php | 2 +- CRM/Event/Cart/Form/MerParticipant.php | 2 +- CRM/Event/Info.php | 14 +++++++------- CRM/Financial/BAO/ExportFormat.php | 4 ++-- CRM/Grant/Info.php | 16 ++++++++-------- CRM/Mailing/BAO/Mailing.php | 4 ++-- CRM/Mailing/BAO/MailingJob.php | 10 +++++----- CRM/Mailing/Info.php | 14 +++++++------- CRM/Member/Info.php | 14 +++++++------- CRM/PCP/Page/PCP.php | 2 +- CRM/Pledge/Info.php | 12 ++++++------ CRM/Report/Form.php | 12 ++++++------ CRM/Report/Form/Contact/Detail.php | 4 ++-- CRM/Report/Form/Contribute/History.php | 6 +++--- CRM/Report/Form/Contribute/Lybunt.php | 2 +- CRM/Report/Form/Contribute/Sybunt.php | 2 +- CRM/Report/Form/Event/ParticipantListCount.php | 2 +- CRM/Report/Form/Event/Summary.php | 2 +- CRM/Report/Info.php | 14 +++++++------- CRM/Report/Utils/Get.php | 2 +- CRM/Report/Utils/Report.php | 2 +- CRM/Upgrade/Incremental/php/FourThree.php | 2 +- CRM/Utils/Migrate/ExportJSON.php | 6 +++--- CRM/Utils/REST.php | 4 ++-- CRM/Utils/Rule.php | 6 +++--- api/Exception.php | 4 ++-- .../CRM/Event/BAO/AdditionalPaymentTest.php | 2 +- .../phpunit/CiviTest/CiviSeleniumTestCase.php | 10 +++++----- tests/phpunit/CiviTest/CiviUnitTestCase.php | 12 ++++++------ .../WebTest/Admin/MoveCustomDataTest.php | 18 +++++++++--------- .../WebTest/Contact/AdvancedSearchTest.php | 16 ++++++++-------- .../Contact/CreateCmsUserFromContactTest.php | 4 ++-- .../WebTest/Contact/SearchBuilderTest.php | 2 +- .../Contribute/OfflineContributionTest.php | 4 ++-- .../phpunit/WebTest/Release/InstallScript.php | 8 ++++---- .../WebTest/Release/ReleaseTestCase.php | 8 ++++---- .../phpunit/WebTest/Release/UpgradeScript.php | 8 ++++---- 57 files changed, 186 insertions(+), 186 deletions(-) diff --git a/CRM/Campaign/Form/Petition/Signature.php b/CRM/Campaign/Form/Petition/Signature.php index b694f76ae6..1fe046fcad 100644 --- a/CRM/Campaign/Form/Petition/Signature.php +++ b/CRM/Campaign/Form/Petition/Signature.php @@ -662,8 +662,8 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { return parent::getTemplateFileName(); } - // check if user has already signed this petition /** + * check if user has already signed this petition * @param array $params */ public function redirectIfSigned($params) { diff --git a/CRM/Campaign/Info.php b/CRM/Campaign/Info.php index 07a838bd9b..dd54957eb9 100644 --- a/CRM/Campaign/Info.php +++ b/CRM/Campaign/Info.php @@ -40,8 +40,8 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { // docs inherited from interface protected $keyword = 'campaign'; - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function getInfo() { @@ -55,8 +55,8 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { } - // docs inherited from interface /** + * docs inherited from interface * @param bool $getAllUnconditionally * * @return array @@ -74,8 +74,8 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { } - // docs inherited from interface /** + * docs inherited from interface * @return null */ public function getUserDashboardElement() { @@ -91,8 +91,8 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { return NULL; } - // docs inherited from interface /** + * docs inherited from interface * @return null */ public function registerTab() { @@ -100,8 +100,8 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { return NULL; } - // docs inherited from interface /** + * docs inherited from interface * @return null */ public function registerAdvancedSearchPane() { @@ -109,16 +109,15 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { return NULL; } - // docs inherited from interface /** - * @return null + * @inheritdoc */ public function getActivityTypes() { return NULL; } - // add shortcut to Create New /** + * add shortcut to Create New * @param $shortCuts */ public function creatNewShortcut(&$shortCuts) { diff --git a/CRM/Case/Info.php b/CRM/Case/Info.php index d24104ccf1..86193fe143 100644 --- a/CRM/Case/Info.php +++ b/CRM/Case/Info.php @@ -41,8 +41,8 @@ class CRM_Case_Info extends CRM_Core_Component_Info { // docs inherited from interface protected $keyword = 'case'; - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function getInfo() { @@ -74,8 +74,8 @@ class CRM_Case_Info extends CRM_Core_Component_Info { return $result; } - // docs inherited from interface /** + * docs inherited from interface * @return array * @throws CRM_Core_Exception */ @@ -88,8 +88,8 @@ class CRM_Case_Info extends CRM_Core_Component_Info { return $entities; } - // docs inherited from interface /** + * docs inherited from interface * @param bool $getAllUnconditionally * * @return array @@ -139,16 +139,16 @@ class CRM_Case_Info extends CRM_Core_Component_Info { return $result; } - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function getUserDashboardElement() { return array(); } - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function registerTab() { @@ -159,8 +159,8 @@ class CRM_Case_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function registerAdvancedSearchPane() { @@ -170,16 +170,16 @@ class CRM_Case_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * @return null */ public function getActivityTypes() { return NULL; } - // add shortcut to Create New /** + * add shortcut to Create New * @param $shortCuts */ public function creatNewShortcut(&$shortCuts) { diff --git a/CRM/Case/XMLProcessor/Settings.php b/CRM/Case/XMLProcessor/Settings.php index a2499e6611..2622baf043 100644 --- a/CRM/Case/XMLProcessor/Settings.php +++ b/CRM/Case/XMLProcessor/Settings.php @@ -36,9 +36,9 @@ class CRM_Case_XMLProcessor_Settings extends CRM_Case_XMLProcessor { private $_settings = array(); - // Input: The base filename without the .xml extension - // Output: An array of settings. /** + * Input: The base filename without the .xml extension + * Output: An array of settings. * @param string $filename * * @return array diff --git a/CRM/Contact/Form/Search/Custom/ActivitySearch.php b/CRM/Contact/Form/Search/Custom/ActivitySearch.php index c518532a9d..2c9aeca5f0 100644 --- a/CRM/Contact/Form/Search/Custom/ActivitySearch.php +++ b/CRM/Contact/Form/Search/Custom/ActivitySearch.php @@ -240,17 +240,17 @@ ORDER BY contact_a.sort_name'; return $sql; } - // Alters the date display in the Activity Date Column. We do this after we already have - // the result so that sorting on the date column stays pertinent to the numeric date value /** + * Alters the date display in the Activity Date Column. We do this after we already have + * the result so that sorting on the date column stays pertinent to the numeric date value * @param $row */ public function alterRow(&$row) { $row['activity_date'] = CRM_Utils_Date::customFormat($row['activity_date'], '%B %E%f, %Y %l:%M %P'); } - // Regular JOIN statements here to limit results to contacts who have activities. /** + * Regular JOIN statements here to limit results to contacts who have activities. * @return string */ public function from() { diff --git a/CRM/Contact/Form/Search/Custom/Base.php b/CRM/Contact/Form/Search/Custom/Base.php index 227c58efb2..cca35084f2 100644 --- a/CRM/Contact/Form/Search/Custom/Base.php +++ b/CRM/Contact/Form/Search/Custom/Base.php @@ -221,9 +221,9 @@ class CRM_Contact_Form_Search_Custom_Base { return CRM_Core_DAO::composeQuery($where, $params, TRUE); } - // override this method to define the contact query object - // used for creating $sql /** + * override this method to define the contact query object + * used for creating $sql * @return null */ public function getQueryObj() { diff --git a/CRM/Contribute/Info.php b/CRM/Contribute/Info.php index b8054e989a..ff71b916f7 100644 --- a/CRM/Contribute/Info.php +++ b/CRM/Contribute/Info.php @@ -41,8 +41,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { // docs inherited from interface protected $keyword = 'contribute'; - // docs inherited from interface /** + * docs inherited from interface * Provides base information about the component. * Needs to be implemented in component's information * class. @@ -63,8 +63,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides permissions that are used by component. * Needs to be implemented in component's information * class. @@ -107,8 +107,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides information about user dashboard element * offered by this component. * @@ -128,8 +128,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides information about user dashboard element * offered by this component. * @@ -148,8 +148,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides information about advanced search pane * offered by this component. * @@ -167,8 +167,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides potential activity types that this * component might want to register in activity history. * Needs to be implemented in component's information @@ -184,8 +184,8 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { return NULL; } - // add shortcut to Create New /** + * add shortcut to Create New * @param $shortCuts * @param $newCredit */ diff --git a/CRM/Core/CodeGen/BaseTask.php b/CRM/Core/CodeGen/BaseTask.php index b9890e9bf4..88ac1f469d 100644 --- a/CRM/Core/CodeGen/BaseTask.php +++ b/CRM/Core/CodeGen/BaseTask.php @@ -11,10 +11,11 @@ abstract class CRM_Core_CodeGen_BaseTask implements CRM_Core_CodeGen_ITask { public function __construct() { } - // TODO: this is the most rudimentary possible hack. CG config should - // eventually be made into a first-class object. /** - * @param is $config + * TODO: this is the most rudimentary possible hack. CG config should + * eventually be made into a first-class object. + * + * @param object $config */ public function setConfig($config) { $this->config = $config; diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php index f9c4ec35d3..6c0cff5d30 100644 --- a/CRM/Core/Error.php +++ b/CRM/Core/Error.php @@ -46,8 +46,8 @@ require_once 'Log.php'; * Class CRM_Exception */ class CRM_Exception extends PEAR_Exception { - // Redefine the exception so message isn't optional /** + * Redefine the exception so message isn't optional * Supported signatures: * - PEAR_Exception(string $message); * - PEAR_Exception(string $message, int $code); @@ -74,7 +74,6 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * Status code of various types of errors - * @var const */ const FATAL_ERROR = 2; const DUPLICATE_CONTACT = 8001; @@ -250,10 +249,11 @@ class CRM_Core_Error extends PEAR_ErrorStack { self::abend(1); } - // this function is used to trap and print errors - // during system initialization time. Hence the error - // message is quite ugly /** + * this function is used to trap and print errors + * during system initialization time. Hence the error + * message is quite ugly + * * @param $pearError */ public static function simpleHandler($pearError) { diff --git a/CRM/Core/Exception.php b/CRM/Core/Exception.php index 7be50c964a..ae70952203 100644 --- a/CRM/Core/Exception.php +++ b/CRM/Core/Exception.php @@ -52,8 +52,8 @@ class CRM_Core_Exception extends PEAR_Exception { $this->errorData = $errorData + array('error_code' => $error_code); } - // custom string representation of object /** + * custom string representation of object * @return string */ public function __toString() { diff --git a/CRM/Core/Payment/BaseIPN.php b/CRM/Core/Payment/BaseIPN.php index 1ce44b3061..bfe01f76c7 100644 --- a/CRM/Core/Payment/BaseIPN.php +++ b/CRM/Core/Payment/BaseIPN.php @@ -1017,9 +1017,8 @@ LIMIT 1;"; return $lineSets; } - // function to copy custom data of the - // initial contribution into its recurring contributions /** + * copy custom data of the initial contribution into its recurring contributions * @param int $recurId * @param int $targetContributionId */ @@ -1062,9 +1061,10 @@ LIMIT 1;"; } } - // function to copy soft credit record of first recurring contribution - // and add new soft credit against $targetContributionId /** + * copy soft credit record of first recurring contribution + * and add new soft credit against $targetContributionId + * * @param int $recurId * @param int $targetContributionId */ diff --git a/CRM/Core/Payment/Moneris.php b/CRM/Core/Payment/Moneris.php index 9f8e000e88..48372a2c5a 100644 --- a/CRM/Core/Payment/Moneris.php +++ b/CRM/Core/Payment/Moneris.php @@ -253,8 +253,8 @@ class CRM_Core_Payment_Moneris extends CRM_Core_Payment { return TRUE; } - // ignore for now, more elaborate error handling later. /** + * ignore for now, more elaborate error handling later. * @param $response * * @return object diff --git a/CRM/Core/Payment/PayJunction.php b/CRM/Core/Payment/PayJunction.php index e9f78a0270..f6741840f6 100644 --- a/CRM/Core/Payment/PayJunction.php +++ b/CRM/Core/Payment/PayJunction.php @@ -198,8 +198,8 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { } - // ignore for now, more elaborate error handling later. /** + * ignore for now, more elaborate error handling later. * @param $response * * @return mixed diff --git a/CRM/Core/Payment/PayflowPro.php b/CRM/Core/Payment/PayflowPro.php index adbc43bcd4..c62d3b0b14 100644 --- a/CRM/Core/Payment/PayflowPro.php +++ b/CRM/Core/Payment/PayflowPro.php @@ -410,8 +410,8 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { // function checkConfig( $mode ) // CiviCRM V1.9 Declaration - // CiviCRM V2.0 Declaration /** + * CiviCRM V2.0 Declaration * This function checks to see if we have the right config values * * @internal param string $mode the mode we are operating in (live or test) diff --git a/CRM/Core/Smarty/Permissions.php b/CRM/Core/Smarty/Permissions.php index a64389565d..9e2f35b006 100644 --- a/CRM/Core/Smarty/Permissions.php +++ b/CRM/Core/Smarty/Permissions.php @@ -4,8 +4,8 @@ * Class CRM_Core_Smarty_Permissions */ class CRM_Core_Smarty_Permissions { - // non-static adapter for CRM_Core_Permission::check /** + * non-static adapter for CRM_Core_Permission::check * @param $offset * * @return bool diff --git a/CRM/Dedupe/BAO/QueryBuilder/IndividualGeneral.php b/CRM/Dedupe/BAO/QueryBuilder/IndividualGeneral.php index f65884c162..a3670968df 100644 --- a/CRM/Dedupe/BAO/QueryBuilder/IndividualGeneral.php +++ b/CRM/Dedupe/BAO/QueryBuilder/IndividualGeneral.php @@ -1,7 +1,7 @@ participant->get_participant_index()}"; } - //XXX poor name /** + * XXX poor name * @param $participant * * @return CRM_Event_Cart_Form_MerParticipant diff --git a/CRM/Event/Info.php b/CRM/Event/Info.php index f2a832bf73..9399c0a63c 100644 --- a/CRM/Event/Info.php +++ b/CRM/Event/Info.php @@ -40,8 +40,8 @@ class CRM_Event_Info extends CRM_Core_Component_Info { // docs inherited from interface protected $keyword = 'event'; - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function getInfo() { @@ -54,8 +54,8 @@ class CRM_Event_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * @param bool $getAllUnconditionally * * @return array @@ -81,8 +81,8 @@ class CRM_Event_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function getUserDashboardElement() { @@ -94,8 +94,8 @@ class CRM_Event_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function registerTab() { @@ -107,8 +107,8 @@ class CRM_Event_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function registerAdvancedSearchPane() { @@ -118,8 +118,8 @@ class CRM_Event_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function getActivityTypes() { @@ -131,8 +131,8 @@ class CRM_Event_Info extends CRM_Core_Component_Info { return $types; } - // add shortcut to Create New /** + * add shortcut to Create New * @param $shortCuts * @param $newCredit */ diff --git a/CRM/Financial/BAO/ExportFormat.php b/CRM/Financial/BAO/ExportFormat.php index d664af865a..06e33b7609 100644 --- a/CRM/Financial/BAO/ExportFormat.php +++ b/CRM/Financial/BAO/ExportFormat.php @@ -59,8 +59,8 @@ class CRM_Financial_BAO_ExportFormat { } } - // Override to assemble the appropriate subset of financial data for the specific export format /** + * Override to assemble the appropriate subset of financial data for the specific export format * @param array $exportParams * * @return mixed @@ -102,8 +102,8 @@ class CRM_Financial_BAO_ExportFormat { return 'txt'; } - // Override this if appropriate /** + * Override this if appropriate * @return null */ public function getTemplateFileName() { diff --git a/CRM/Grant/Info.php b/CRM/Grant/Info.php index 0176c5af35..5a8a4620ac 100644 --- a/CRM/Grant/Info.php +++ b/CRM/Grant/Info.php @@ -40,8 +40,8 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { // docs inherited from interface protected $keyword = 'grant'; - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function getInfo() { @@ -56,8 +56,8 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { } - // docs inherited from interface /** + * docs inherited from interface * @param bool $getAllUnconditionally * * @return array @@ -70,8 +70,8 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * @return null */ public function getUserDashboardElement() { @@ -79,8 +79,8 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { return NULL; } - // docs inherited from interface /** + * docs inherited from interface * @return null */ public function getUserDashboardObject() { @@ -88,8 +88,8 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { return NULL; } - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function registerTab() { @@ -100,8 +100,8 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function registerAdvancedSearchPane() { @@ -111,16 +111,16 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * @return null */ public function getActivityTypes() { return NULL; } - // add shortcut to Create New /** + * add shortcut to Create New * @param $shortCuts */ public function creatNewShortcut(&$shortCuts) { diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index 5035d67e7a..0c0b959a72 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -109,9 +109,9 @@ class CRM_Mailing_BAO_Mailing extends CRM_Mailing_DAO_Mailing { return $eq->N; } - // note that $job_id is used only as a variable in the temp table construction - // and does not play a role in the queries generated /** + * note that $job_id is used only as a variable in the temp table construction + * and does not play a role in the queries generated * @param int $job_id * (misnomer) a nonce value used to name temporary tables. * @param int $mailing_id diff --git a/CRM/Mailing/BAO/MailingJob.php b/CRM/Mailing/BAO/MailingJob.php index 896808feee..9df531b71e 100644 --- a/CRM/Mailing/BAO/MailingJob.php +++ b/CRM/Mailing/BAO/MailingJob.php @@ -221,9 +221,9 @@ class CRM_Mailing_BAO_MailingJob extends CRM_Mailing_DAO_MailingJob { } } - // post process to determine if the parent job - // as well as the mailing is complete after the run /** + * post process to determine if the parent job + * as well as the mailing is complete after the run * @param null $mode */ public static function runJobs_post($mode = NULL) { @@ -293,8 +293,8 @@ class CRM_Mailing_BAO_MailingJob extends CRM_Mailing_DAO_MailingJob { } - // before we run jobs, we need to split the jobs /** + * before we run jobs, we need to split the jobs * @param int $offset * @param null $mode */ @@ -380,9 +380,9 @@ class CRM_Mailing_BAO_MailingJob extends CRM_Mailing_DAO_MailingJob { } } - // Split the parent job into n number of child job based on an offset - // If null or 0 , we create only one child job /** + * Split the parent job into n number of child job based on an offset + * If null or 0 , we create only one child job * @param int $offset */ public function split_job($offset = 200) { diff --git a/CRM/Mailing/Info.php b/CRM/Mailing/Info.php index f3709988c0..03196ea84d 100644 --- a/CRM/Mailing/Info.php +++ b/CRM/Mailing/Info.php @@ -41,8 +41,8 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { protected $keyword = 'mailing'; - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function getInfo() { @@ -177,8 +177,8 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { ) ? TRUE : FALSE; } - // docs inherited from interface /** + * docs inherited from interface * @param bool $getAllUnconditionally * * @return array @@ -201,8 +201,8 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { } - // docs inherited from interface /** + * docs inherited from interface * @return null */ public function getUserDashboardElement() { @@ -218,8 +218,8 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { return NULL; } - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function registerTab() { @@ -231,8 +231,8 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * @return array */ public function registerAdvancedSearchPane() { @@ -242,16 +242,16 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * @return null */ public function getActivityTypes() { return NULL; } - // add shortcut to Create New /** + * add shortcut to Create New * @param $shortCuts */ public function creatNewShortcut(&$shortCuts) { diff --git a/CRM/Member/Info.php b/CRM/Member/Info.php index 32672bf103..b362c4ecd3 100644 --- a/CRM/Member/Info.php +++ b/CRM/Member/Info.php @@ -40,8 +40,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { // docs inherited from interface protected $keyword = 'member'; - // docs inherited from interface /** + * docs inherited from interface * Provides base information about the component. * Needs to be implemented in component's information * class. @@ -63,8 +63,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { } - // docs inherited from interface /** + * docs inherited from interface * Provides permissions that are used by component. * Needs to be implemented in component's information * class. @@ -90,8 +90,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides information about user dashboard element * offered by this component. * @@ -114,8 +114,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides information about user dashboard element * offered by this component. * @@ -134,8 +134,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides information about advanced search pane * offered by this component. * @@ -153,8 +153,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides potential activity types that this * component might want to register in activity history. * Needs to be implemented in component's information @@ -170,8 +170,8 @@ class CRM_Member_Info extends CRM_Core_Component_Info { return NULL; } - // add shortcut to Create New /** + * add shortcut to Create New * @param $shortCuts * @param $newCredit */ diff --git a/CRM/PCP/Page/PCP.php b/CRM/PCP/Page/PCP.php index 4944b06e81..0dcee85e39 100644 --- a/CRM/PCP/Page/PCP.php +++ b/CRM/PCP/Page/PCP.php @@ -389,8 +389,8 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { return 'civicrm/admin/pcp'; } - //@TODO this function changed, debug this at runtime /** + * @TODO this function changed, debug this at runtime * @param $whereClause * @param array $whereParams */ diff --git a/CRM/Pledge/Info.php b/CRM/Pledge/Info.php index 6edfd588ef..caa5f44941 100644 --- a/CRM/Pledge/Info.php +++ b/CRM/Pledge/Info.php @@ -59,8 +59,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { } - // docs inherited from interface /** + * docs inherited from interface * Provides permissions that are used by component. * Needs to be implemented in component's information * class. @@ -86,8 +86,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides information about user dashboard element * offered by this component. * @@ -108,8 +108,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides information about user dashboard element * offered by this component. * @@ -128,8 +128,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides information about advanced search pane * offered by this component. * @@ -147,8 +147,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { ); } - // docs inherited from interface /** + * docs inherited from interface * Provides potential activity types that this * component might want to register in activity history. * Needs to be implemented in component's information @@ -164,8 +164,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { return NULL; } - // add shortcut to Create New /** + * add shortcut to Create New * @param $shortCuts */ public function creatNewShortcut(&$shortCuts) { diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php index 70b027e27f..881730e608 100644 --- a/CRM/Report/Form.php +++ b/CRM/Report/Form.php @@ -1213,10 +1213,10 @@ class CRM_Report_Form extends CRM_Core_Form { } } - // a formrule function to ensure that fields selected in group_by - // (if any) should only be the ones present in display/select fields criteria; - // note: works if and only if any custom field selected in group_by. /** + * a formrule function to ensure that fields selected in group_by + * (if any) should only be the ones present in display/select fields criteria; + * note: works if and only if any custom field selected in group_by. * @param $fields * @param array $ignoreFields * @@ -1254,9 +1254,9 @@ class CRM_Report_Form extends CRM_Core_Form { return $errors; } - // Note: $fieldName param allows inheriting class to build operationPairs - // specific to a field. /** + * Note: $fieldName param allows inheriting class to build operationPairs + * specific to a field. * @param string $type * @param null $fieldName * @@ -2640,8 +2640,8 @@ WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND $this->assign('statistics', $this->statistics($rows)); } - // override this method to build your own statistics /** + * override this method to build your own statistics * @param $rows * * @return array diff --git a/CRM/Report/Form/Contact/Detail.php b/CRM/Report/Form/Contact/Detail.php index 6d3b80d7f2..842841c73c 100644 --- a/CRM/Report/Form/Contact/Detail.php +++ b/CRM/Report/Form/Contact/Detail.php @@ -744,16 +744,16 @@ class CRM_Report_Form_Contact_Detail extends CRM_Report_Form { return $statistics; } - //Override to set limit is 10 /** + * Override to set limit is 10 * @param int $rowCount */ public function limit($rowCount = self::ROW_COUNT_LIMIT) { parent::limit($rowCount); } - //Override to set pager with limit is 10 /** + * Override to set pager with limit is 10 * @param int $rowCount */ public function setPager($rowCount = self::ROW_COUNT_LIMIT) { diff --git a/CRM/Report/Form/Contribute/History.php b/CRM/Report/Form/Contribute/History.php index 02f6bd88e9..0f43b3b40f 100644 --- a/CRM/Report/Form/Contribute/History.php +++ b/CRM/Report/Form/Contribute/History.php @@ -419,16 +419,16 @@ class CRM_Report_Form_Contribute_History extends CRM_Report_Form { $this->_groupBy = "GROUP BY {$this->_aliases['civicrm_contribution']}.contact_id, YEAR({$this->_aliases['civicrm_contribution']}.receive_date)"; } - //Override to set limit is 10 /** + * Override to set limit is 10 * @param int $rowCount */ public function limit($rowCount = self::ROW_COUNT_LIMIT) { parent::limit($rowCount); } - //Override to set pager with limit is 10 /** + * Override to set pager with limit is 10 * @param int $rowCount */ public function setPager($rowCount = self::ROW_COUNT_LIMIT) { @@ -710,8 +710,8 @@ class CRM_Report_Form_Contribute_History extends CRM_Report_Form { return array($relationshipRows, $relatedContactIds); } - // Override "This Year" $op options /** + * Override "This Year" $op options * @param string $type * @param null $fieldName * diff --git a/CRM/Report/Form/Contribute/Lybunt.php b/CRM/Report/Form/Contribute/Lybunt.php index 981721d118..75ca55c5a0 100644 --- a/CRM/Report/Form/Contribute/Lybunt.php +++ b/CRM/Report/Form/Contribute/Lybunt.php @@ -499,8 +499,8 @@ class CRM_Report_Form_Contribute_Lybunt extends CRM_Report_Form { } } - // Override "This Year" $op options /** + * Override "This Year" $op options * @param string $type * @param null $fieldName * diff --git a/CRM/Report/Form/Contribute/Sybunt.php b/CRM/Report/Form/Contribute/Sybunt.php index 744549750b..67f6f21f21 100644 --- a/CRM/Report/Form/Contribute/Sybunt.php +++ b/CRM/Report/Form/Contribute/Sybunt.php @@ -516,8 +516,8 @@ class CRM_Report_Form_Contribute_Sybunt extends CRM_Report_Form { } } - // Override "This Year" $op options /** + * Override "This Year" $op options * @param string $type * @param null $fieldName * diff --git a/CRM/Report/Form/Event/ParticipantListCount.php b/CRM/Report/Form/Event/ParticipantListCount.php index b0d87a15a2..960d5ed3cc 100644 --- a/CRM/Report/Form/Event/ParticipantListCount.php +++ b/CRM/Report/Form/Event/ParticipantListCount.php @@ -270,8 +270,8 @@ class CRM_Report_Form_Event_ParticipantListCount extends CRM_Report_Form_Event { parent::preProcess(); } - //Add The statistics /** + * Add The statistics * @param $rows * * @return array diff --git a/CRM/Report/Form/Event/Summary.php b/CRM/Report/Form/Event/Summary.php index f2fbc92d6e..e649777b00 100644 --- a/CRM/Report/Form/Event/Summary.php +++ b/CRM/Report/Form/Event/Summary.php @@ -181,8 +181,8 @@ class CRM_Report_Form_Event_Summary extends CRM_Report_Form_Event { $this->_groupBy = " GROUP BY {$this->_aliases['civicrm_event']}.id"; } - //get participants information for events /** + * get participants information for events * @return array */ public function participantInfo() { diff --git a/CRM/Report/Info.php b/CRM/Report/Info.php index 5d461d9957..9354f5e82f 100644 --- a/CRM/Report/Info.php +++ b/CRM/Report/Info.php @@ -40,8 +40,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { // docs inherited from interface protected $keyword = 'report'; - // docs inherited from interface /** + * docs inherited from interface * Provides base information about the component. * Needs to be implemented in component's information * class. @@ -63,8 +63,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { } - // docs inherited from interface /** + * docs inherited from interface * Provides permissions that are used by component. * Needs to be implemented in component's information * class. @@ -87,8 +87,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { } - // docs inherited from interface /** + * docs inherited from interface * Provides information about user dashboard element * offered by this component. * @@ -118,8 +118,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { return NULL; } - // docs inherited from interface /** + * docs inherited from interface * Provides information about user dashboard element * offered by this component. * @@ -135,8 +135,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { return NULL; } - // docs inherited from interface /** + * docs inherited from interface * Provides information about advanced search pane * offered by this component. * @@ -152,8 +152,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { return NULL; } - // docs inherited from interface /** + * docs inherited from interface * Provides potential activity types that this * component might want to register in activity history. * Needs to be implemented in component's information @@ -169,8 +169,8 @@ class CRM_Report_Info extends CRM_Core_Component_Info { return NULL; } - // add shortcut to Create New /** + * add shortcut to Create New * @param $shortCuts */ public function creatNewShortcut(&$shortCuts) { diff --git a/CRM/Report/Utils/Get.php b/CRM/Report/Utils/Get.php index 62665b4dbf..17cbbce44e 100644 --- a/CRM/Report/Utils/Get.php +++ b/CRM/Report/Utils/Get.php @@ -232,8 +232,8 @@ class CRM_Report_Utils_Get { } } - //unset default filters /** + * unset default filters * @param $defaults */ public static function unsetFilters(&$defaults) { diff --git a/CRM/Report/Utils/Report.php b/CRM/Report/Utils/Report.php index 93cdac329a..a0a2bf9971 100644 --- a/CRM/Report/Utils/Report.php +++ b/CRM/Report/Utils/Report.php @@ -155,8 +155,8 @@ WHERE TRIM(BOTH '/' FROM CONCAT(report_id, '/', name)) = %1"; } } - // get instance count for a template /** + * get instance count for a template * @param $optionVal * * @return int|null|string diff --git a/CRM/Upgrade/Incremental/php/FourThree.php b/CRM/Upgrade/Incremental/php/FourThree.php index b57ede35a9..db8dfa79ae 100644 --- a/CRM/Upgrade/Incremental/php/FourThree.php +++ b/CRM/Upgrade/Incremental/php/FourThree.php @@ -419,8 +419,8 @@ ADD CONSTRAINT `FK_civicrm_financial_item_contact_id` FOREIGN KEY (`contact_id`) $this->addTask('Update Line Item Data', 'updateLineItemData', $rev); } - //CRM-11636 /** + * CRM-11636 * @return bool */ public function assignFinancialTypeToPriceRecords() { diff --git a/CRM/Utils/Migrate/ExportJSON.php b/CRM/Utils/Migrate/ExportJSON.php index 3ecec2efd4..4cda5c0e1c 100644 --- a/CRM/Utils/Migrate/ExportJSON.php +++ b/CRM/Utils/Migrate/ExportJSON.php @@ -298,9 +298,9 @@ SELECT * $this->table($contactIDs, 'civicrm_group_contact', $fields, 'contact_id', NULL); } - // TODO - support group inheritance - // Parent child group ids are encoded in a text string /** + * TODO - support group inheritance + * Parent child group ids are encoded in a text string * @param $contactIDs */ public function group(&$contactIDs) { @@ -329,8 +329,8 @@ WHERE contact_id IN ( $ids ) $this->savedSearch($groupIDs); } - // TODO - support search builder and custom saved searches /** + * TODO - support search builder and custom saved searches * @param $groupIDs */ public function savedSearch(&$groupIDs) { diff --git a/CRM/Utils/REST.php b/CRM/Utils/REST.php index 5ecf2ae45d..12723bce09 100644 --- a/CRM/Utils/REST.php +++ b/CRM/Utils/REST.php @@ -73,8 +73,8 @@ class CRM_Utils_REST { return self::simple(array('message' => "PONG: $key")); } - // Generates values needed for error messages /** + * Generates values needed for error messages * @param string $message * * @return array @@ -87,8 +87,8 @@ class CRM_Utils_REST { return $values; } - // Generates values needed for non-error responses. /** + * Generates values needed for non-error responses. * @param array $params * * @return array diff --git a/CRM/Utils/Rule.php b/CRM/Utils/Rule.php index 0a737d1309..fbd45cedd2 100644 --- a/CRM/Utils/Rule.php +++ b/CRM/Utils/Rule.php @@ -538,10 +538,10 @@ class CRM_Utils_Rule { return TRUE; } - // allow between 4-6 digits as postal code since india needs 6 and US needs 5 (or - // if u disregard the first 0, 4 (thanx excel!) - // FIXME: we need to figure out how to localize such rules /** + * allow between 4-6 digits as postal code since india needs 6 and US needs 5 (or + * if u disregard the first 0, 4 (thanx excel!) + * FIXME: we need to figure out how to localize such rules * @param $value * * @return bool diff --git a/api/Exception.php b/api/Exception.php index 1ee7914cbf..7f0186b88f 100644 --- a/api/Exception.php +++ b/api/Exception.php @@ -47,8 +47,8 @@ class API_Exception extends Exception { $this->extraParams = $extraParams + array('error_code' => $error_code); } - // custom string representation of object /** + * custom string representation of object * @return string */ public function __toString() { @@ -101,8 +101,8 @@ class CiviCRM_API3_Exception extends Exception { $this->extraParams = $extraParams + array('error_code' => $error_code); } - // custom string representation of object /** + * custom string representation of object * @return string */ public function __toString() { diff --git a/tests/phpunit/CRM/Event/BAO/AdditionalPaymentTest.php b/tests/phpunit/CRM/Event/BAO/AdditionalPaymentTest.php index 0b2efc55e7..abd5f28d6d 100644 --- a/tests/phpunit/CRM/Event/BAO/AdditionalPaymentTest.php +++ b/tests/phpunit/CRM/Event/BAO/AdditionalPaymentTest.php @@ -59,8 +59,8 @@ class CRM_Event_BAO_AdditionalPaymentTest extends CiviUnitTestCase { ); } - // helper function to record participant with paid contribution /** + * helper function to record participant with paid contribution * @param $feeTotal * @param $actualPaidAmt * diff --git a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php index c8e8556c0d..e926a1194e 100644 --- a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php +++ b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php @@ -1631,8 +1631,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { return CiviDBAssert::assertDBState($this, $daoName, $id, $match, $delete); } - // Request a record from the DB by seachColumn+searchValue. Success if a record is found. /** + * Request a record from the DB by seachColumn+searchValue. Success if a record is found. * @param string $daoName * @param $searchValue * @param $returnColumn @@ -1649,8 +1649,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { return CiviDBAssert::assertDBNotNull($this, $daoName, $searchValue, $returnColumn, $searchColumn, $message); } - // Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL. /** + * Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL. * @param string $daoName * @param $searchValue * @param $returnColumn @@ -1665,8 +1665,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { return CiviDBAssert::assertDBNull($this, $daoName, $searchValue, $returnColumn, $searchColumn, $message); } - // Request a record from the DB by id. Success if row not found. /** + * Request a record from the DB by id. Success if row not found. * @param string $daoName * @param int $id * @param $message @@ -1679,8 +1679,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { return CiviDBAssert::assertDBRowNotExist($this, $daoName, $id, $message); } - // Compare a single column value in a retrieved DB record to an expected value /** + * Compare a single column value in a retrieved DB record to an expected value * @param string $daoName * @param $searchValue * @param $returnColumn @@ -1701,8 +1701,8 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { ); } - // Compare all values in a single retrieved DB record to an array of expected values /** + * Compare all values in a single retrieved DB record to an array of expected values * @param string $daoName * @param array $searchParams * @param $expectedValues diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php index b57671daee..cde898f8a9 100755 --- a/tests/phpunit/CiviTest/CiviUnitTestCase.php +++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php @@ -600,8 +600,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { } } - // Request a record from the DB by seachColumn+searchValue. Success if a record is found. /** + * Request a record from the DB by seachColumn+searchValue. Success if a record is found. * @param string $daoName * @param $searchValue * @param $returnColumn @@ -621,8 +621,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { return $value; } - // Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL. /** + * Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL. * @param string $daoName * @param $searchValue * @param $returnColumn @@ -634,8 +634,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { $this->assertNull($value, $message); } - // Request a record from the DB by id. Success if row not found. /** + * Request a record from the DB by id. Success if row not found. * @param string $daoName * @param int $id * @param null $message @@ -646,8 +646,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { $this->assertNull($value, $message); } - // Request a record from the DB by id. Success if row not found. /** + * Request a record from the DB by id. Success if row not found. * @param string $daoName * @param int $id * @param null $message @@ -658,8 +658,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { $this->assertEquals($id, $value, $message); } - // Compare a single column value in a retrieved DB record to an expected value /** + * Compare a single column value in a retrieved DB record to an expected value * @param string $daoName * @param $searchValue * @param $returnColumn @@ -675,8 +675,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { $this->assertEquals($value, $expectedValue, $message); } - // Compare all values in a single retrieved DB record to an array of expected values /** + * Compare all values in a single retrieved DB record to an array of expected values * @param string $daoName * @param array $searchParams * @param $expectedValues diff --git a/tests/phpunit/WebTest/Admin/MoveCustomDataTest.php b/tests/phpunit/WebTest/Admin/MoveCustomDataTest.php index 2dd7d4a84d..3f25895f60 100644 --- a/tests/phpunit/WebTest/Admin/MoveCustomDataTest.php +++ b/tests/phpunit/WebTest/Admin/MoveCustomDataTest.php @@ -118,8 +118,8 @@ class WebTest_Admin_MoveCustomDataTest extends CiviSeleniumTestCase { $this->assertElementContainsText("css=div." . $destination['name'], $fields['values'][$field_to_move]['label'], "Moved value does not display in the new fieldset on the contact record"); } - //moves a field from one field to another /** + * moves a field from one field to another * @param $field_to_move * @param int $from_group_id * @param int $to_group_id @@ -148,8 +148,8 @@ class WebTest_Admin_MoveCustomDataTest extends CiviSeleniumTestCase { $this->assertTrue($this->isElementPresent("CustomField-" . $field_to_move), "The moved custom field does not display on the new fieldset page"); } - //create a contact and return the contact id /** + * create a contact and return the contact id * @param string $firstName * @param string $lastName * @@ -165,8 +165,8 @@ class WebTest_Admin_MoveCustomDataTest extends CiviSeleniumTestCase { return $cid; } - //Get all custom field values for a given contact and custom group id using the api /** + * Get all custom field values for a given contact and custom group id using the api * @param int $contact_id * @param int $group_id * @param bool $reset_cache @@ -208,8 +208,8 @@ class WebTest_Admin_MoveCustomDataTest extends CiviSeleniumTestCase { return $results; } - //creates a new custom group and fields in that group, and returns the group Id /** + * creates a new custom group and fields in that group, and returns the group Id * @param $prefix * * @return null @@ -224,8 +224,8 @@ class WebTest_Admin_MoveCustomDataTest extends CiviSeleniumTestCase { return $group_id; } - //Creates a custom field group for a specific entity type and returns the custom group Id /** + * Creates a custom field group for a specific entity type and returns the custom group Id * @param string $prefix * @param string $entity * @@ -253,9 +253,9 @@ class WebTest_Admin_MoveCustomDataTest extends CiviSeleniumTestCase { return $this->urlArg('gid'); } - //Adds a new custom field to a specfied custom field group, using the given - //datatype and widget. /** + * Adds a new custom field to a specfied custom field group, using the given + * datatype and widget. * @param int $group_id * @param string $type * @param string $widget @@ -411,8 +411,8 @@ class WebTest_Admin_MoveCustomDataTest extends CiviSeleniumTestCase { return $results['id']; } - //Populates $count options for a custom field on the add custom field page /** + * Populates $count options for a custom field on the add custom field page * @param int $count * @param string $prefix * @param array $values @@ -428,8 +428,8 @@ class WebTest_Admin_MoveCustomDataTest extends CiviSeleniumTestCase { } } - //randomly generates data for a specific custom field /** + * randomly generates data for a specific custom field * @param int $contact_id * @param int $group_id */ diff --git a/tests/phpunit/WebTest/Contact/AdvancedSearchTest.php b/tests/phpunit/WebTest/Contact/AdvancedSearchTest.php index 3a470752fe..4443d89b56 100644 --- a/tests/phpunit/WebTest/Contact/AdvancedSearchTest.php +++ b/tests/phpunit/WebTest/Contact/AdvancedSearchTest.php @@ -214,8 +214,8 @@ class WebTest_Contact_AdvancedSearchTest extends CiviSeleniumTestCase { } } - //function to check match for sumbit Advance Search /** + * function to check match for sumbit Advance Search * @param string $firstName */ public function submitSearch($firstName) { @@ -258,8 +258,8 @@ class WebTest_Contact_AdvancedSearchTest extends CiviSeleniumTestCase { $this->assertElementNotContainsText("xpath=//div[@class='crm-search-results']//table/tbody/tr[1]/td[6]", $stateBeforeSort); } - // function to fill basic search detail /** + * function to fill basic search detail * @param string $firstName * @param string $groupName * @param $tagName @@ -285,8 +285,8 @@ class WebTest_Contact_AdvancedSearchTest extends CiviSeleniumTestCase { $this->check("preferred_communication_method[2]"); } - // function to fill address search block values in advance search /** + * function to fill address search block values in advance search * @param $firstName */ public function addAddressSearchDetail($firstName) { @@ -306,8 +306,8 @@ class WebTest_Contact_AdvancedSearchTest extends CiviSeleniumTestCase { $this->select2("state_province", "Alaska", TRUE); } - // function to fill activity search block in advance search /** + * function to fill activity search block in advance search * @param $firstName */ public function addActivitySearchDetail($firstName) { @@ -342,8 +342,8 @@ class WebTest_Contact_AdvancedSearchTest extends CiviSeleniumTestCase { $this->check("civicrm_gender_Male_2"); } - //function to fill contribution search details /** + * function to fill contribution search details * @param $firstName */ public function addContributionSearchDetail($firstName) { @@ -384,8 +384,8 @@ class WebTest_Contact_AdvancedSearchTest extends CiviSeleniumTestCase { $this->type("participant_fee_amount_high", "150"); } - // function to fill member search details /** + * function to fill member search details * @param $firstName */ public function addMemberSearchDetail($firstName) { @@ -411,8 +411,8 @@ class WebTest_Contact_AdvancedSearchTest extends CiviSeleniumTestCase { $this->webtestFillDate("member_end_date_high", "+2 year"); } - // function to fill member search details /** + * function to fill member search details * @param $firstName */ public function addPledgeSearchDetail($firstName) { @@ -439,8 +439,8 @@ class WebTest_Contact_AdvancedSearchTest extends CiviSeleniumTestCase { $this->select("pledge_financial_type_id", "Donation"); } - // function to create contact with details (contact details, address, Constituent information ...) /** + * function to create contact with details (contact details, address, Constituent information ...) * @param null $firstName */ public function createDetailContact($firstName = NULL) { diff --git a/tests/phpunit/WebTest/Contact/CreateCmsUserFromContactTest.php b/tests/phpunit/WebTest/Contact/CreateCmsUserFromContactTest.php index 6f6fdb6b2e..815c946134 100644 --- a/tests/phpunit/WebTest/Contact/CreateCmsUserFromContactTest.php +++ b/tests/phpunit/WebTest/Contact/CreateCmsUserFromContactTest.php @@ -26,9 +26,9 @@ require_once 'CiviTest/CiviSeleniumTestCase.php'; -//Tests for the ability to add a CMS user from a contact's record -//See http://issues.civicrm.org/jira/browse/CRM-8723 /** + * Tests for the ability to add a CMS user from a contact's record + * See http://issues.civicrm.org/jira/browse/CRM-8723 * Class WebTest_Contact_CreateCmsUserFromContactTest */ class WebTest_Contact_CreateCmsUserFromContactTest extends CiviSeleniumTestCase { diff --git a/tests/phpunit/WebTest/Contact/SearchBuilderTest.php b/tests/phpunit/WebTest/Contact/SearchBuilderTest.php index a6aa2a8107..d5686d86af 100644 --- a/tests/phpunit/WebTest/Contact/SearchBuilderTest.php +++ b/tests/phpunit/WebTest/Contact/SearchBuilderTest.php @@ -71,8 +71,8 @@ class WebTest_Contact_SearchBuilderTest extends CiviSeleniumTestCase { $this->_searchBuilder("Postal Code", "100[0-9]", $sortName, "RLIKE"); } - // function to create contact with details (contact details, address, Constituent information ...) /** + * function to create contact with details (contact details, address, Constituent information ...) * @param null $firstName */ public function createDetailContact($firstName = NULL) { diff --git a/tests/phpunit/WebTest/Contribute/OfflineContributionTest.php b/tests/phpunit/WebTest/Contribute/OfflineContributionTest.php index 7026dd9f68..3f49498757 100644 --- a/tests/phpunit/WebTest/Contribute/OfflineContributionTest.php +++ b/tests/phpunit/WebTest/Contribute/OfflineContributionTest.php @@ -308,8 +308,8 @@ class WebTest_Contribute_OfflineContributionTest extends CiviSeleniumTestCase { $this->_verifyAmounts($checkScenario5); } - //common function for doing offline contribution /** + * common function for doing offline contribution * @param array $params * @param string $firstName * @param string $lastName @@ -364,8 +364,8 @@ class WebTest_Contribute_OfflineContributionTest extends CiviSeleniumTestCase { $this->assertTrue($this->isTextPresent("The contribution record has been processed."), "Status message didn't show up after saving!"); } - //common function for verifing total_amount, and non_deductible_amount /** + * common function for verifing total_amount, and non_deductible_amount * @param $verifyData */ public function _verifyAmounts($verifyData) { diff --git a/tests/phpunit/WebTest/Release/InstallScript.php b/tests/phpunit/WebTest/Release/InstallScript.php index d21658532d..9fa85523fc 100644 --- a/tests/phpunit/WebTest/Release/InstallScript.php +++ b/tests/phpunit/WebTest/Release/InstallScript.php @@ -26,11 +26,11 @@ require_once 'ReleaseTestCase.php'; -// name of the class doesn't end with Test on purpose - this way this -// webtest is not picked up by the suite, since it needs to run -// on specially prepare sandbox -// more details: http://wiki.civicrm.org/confluence/display/CRMDOC/Release+testing+script /** + * name of the class doesn't end with Test on purpose - this way this + * webtest is not picked up by the suite, since it needs to run + * on specially prepare sandbox + * more details: http://wiki.civicrm.org/confluence/display/CRMDOC/Release+testing+script * Class WebTest_Release_InstallScript */ class WebTest_Release_InstallScript extends WebTest_Release_ReleaseTestCase { diff --git a/tests/phpunit/WebTest/Release/ReleaseTestCase.php b/tests/phpunit/WebTest/Release/ReleaseTestCase.php index 8a16a97e40..034fcfb51c 100644 --- a/tests/phpunit/WebTest/Release/ReleaseTestCase.php +++ b/tests/phpunit/WebTest/Release/ReleaseTestCase.php @@ -26,11 +26,11 @@ require_once 'CiviTest/CiviSeleniumTestCase.php'; -// name of the class doesn't end with Test on purpose - this way this -// webtest is not picked up by the suite, since it needs to run -// on specially prepare sandbox -// more details: http://wiki.civicrm.org/confluence/display/CRMDOC/Release+testing+script /** + * name of the class doesn't end with Test on purpose - this way this + * webtest is not picked up by the suite, since it needs to run + * on specially prepare sandbox + * more details: http://wiki.civicrm.org/confluence/display/CRMDOC/Release+testing+script * Class WebTest_Release_ReleaseTestCase */ class WebTest_Release_ReleaseTestCase extends CiviSeleniumTestCase { diff --git a/tests/phpunit/WebTest/Release/UpgradeScript.php b/tests/phpunit/WebTest/Release/UpgradeScript.php index eea1b14867..b91531a6f4 100644 --- a/tests/phpunit/WebTest/Release/UpgradeScript.php +++ b/tests/phpunit/WebTest/Release/UpgradeScript.php @@ -26,11 +26,11 @@ require_once 'ReleaseTestCase.php'; -// name of the class doesn't end with Test on purpose - this way this -// webtest is not picked up by the suite, since it needs to run -// on specially prepare sandbox -// more details: http://wiki.civicrm.org/confluence/display/CRMDOC/Release+testing+script /** + * name of the class doesn't end with Test on purpose - this way this + * webtest is not picked up by the suite, since it needs to run + * on specially prepare sandbox + * more details: http://wiki.civicrm.org/confluence/display/CRMDOC/Release+testing+script * Class WebTest_Release_UpgradeScript */ class WebTest_Release_UpgradeScript extends WebTest_Release_ReleaseTestCase { -- 2.25.1