From da3c79799bd6bafa919c6d8724eadf02540b160a Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Sat, 24 May 2014 19:14:24 +1200 Subject: [PATCH] fix spelling errors & a couple of comment blocks --- CRM/Core/BAO/CMSUser.php | 2 +- CRM/Core/BAO/EntityTag.php | 2 +- CRM/Core/BAO/Extension.php | 2 +- CRM/Core/BAO/FinancialTrxn.php | 2 +- CRM/Core/BAO/Setting.php | 2 +- CRM/Core/BAO/UFGroup.php | 2 +- CRM/Core/Error.php | 8 ++++++-- CRM/Core/Lock.php | 2 +- CRM/Core/Permission/DrupalBase.php | 2 +- CRM/Core/Smarty.php | 2 +- CRM/Core/StateMachine.php | 2 +- 11 files changed, 16 insertions(+), 12 deletions(-) diff --git a/CRM/Core/BAO/CMSUser.php b/CRM/Core/BAO/CMSUser.php index ee2df90552..4c08c1fbf1 100644 --- a/CRM/Core/BAO/CMSUser.php +++ b/CRM/Core/BAO/CMSUser.php @@ -260,7 +260,7 @@ class CRM_Core_BAO_CMSUser { * @param object $form * @param integer $gid id of group of profile * @param bool $emailPresent true if the profile field has email(primary) - * @param const $action + * @param \const|int $action * * @return FALSE|void WTF * diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php index 45fb90e2d9..0b242ff87a 100644 --- a/CRM/Core/BAO/EntityTag.php +++ b/CRM/Core/BAO/EntityTag.php @@ -44,7 +44,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * @param string $entityTable name of the entity table usually 'civicrm_contact' * * @return array( - ) reference $tag array of catagory id's the contact belongs to. + ) reference $tag array of category id's the contact belongs to. * * @access public * @static diff --git a/CRM/Core/BAO/Extension.php b/CRM/Core/BAO/Extension.php index dfac8653d6..81d902a627 100644 --- a/CRM/Core/BAO/Extension.php +++ b/CRM/Core/BAO/Extension.php @@ -49,7 +49,7 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { * @param array $params (reference ) an assoc array of name/value pairs * @param array $defaults (reference ) an assoc array to hold the flattened values * - * @return object CRM_Core_BAO_LocaationType object on success, null otherwise + * @return object CRM_Core_BAO_LocationType object on success, null otherwise * @access public * @static */ diff --git a/CRM/Core/BAO/FinancialTrxn.php b/CRM/Core/BAO/FinancialTrxn.php index f7f2e077cb..7008bf9607 100644 --- a/CRM/Core/BAO/FinancialTrxn.php +++ b/CRM/Core/BAO/FinancialTrxn.php @@ -155,7 +155,7 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { * * @internal param string $entityTable name of the entity table usually 'civicrm_contact' * @internal param int $entityID id of the entity usually the contactID. - * @return array( ) reference $tag array of catagory id's the contact belongs to. + * @return array( ) reference $tag array of category id's the contact belongs to. * * @access public * @static diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index e81110dc10..98d88b0b2b 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -67,7 +67,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * * @param string $group (required) The group name of the item * @param string $name (required) The name of the setting - * @param int $componentID The optional component ID (so componenets can share the same name space) + * @param int $componentID The optional component ID (so components can share the same name space) * @param int $contactID If set, this is a contactID specific setting, else its a global setting * @param bool|int $load if true, load from local cache (typically memcache) * diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index 4ad97b78ab..6899680046 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -3456,7 +3456,7 @@ SELECT group_id } /** - * Funtion to determine of we show overlay profile or not + * Function to determine of we show overlay profile or not * * @return boolean true if profile should be shown else false * @static diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php index 56ea895cea..a1c196578d 100644 --- a/CRM/Core/Error.php +++ b/CRM/Core/Error.php @@ -57,9 +57,13 @@ class CRM_Exception extends PEAR_Exception { * - PEAR_Exception(string $message, PEAR_Error $cause, int $code); * - PEAR_Exception(string $message, array $causes); * - PEAR_Exception(string $message, array $causes, int $code); + * * @param string exception message - * @param int|Exception|PEAR_Error|array|null exception cause - * @param int|null exception code or null + * @param int $code + * @param Exception $previous + * + * @internal param array|\Exception|int|null|\PEAR_Error $exception cause + * @internal param int|null $exception code or null */ public function __construct($message = NULL, $code = 0, Exception$previous = NULL) { parent::__construct($message, $code, $previous); diff --git a/CRM/Core/Lock.php b/CRM/Core/Lock.php index 82d9ddb577..e1482c4440 100644 --- a/CRM/Core/Lock.php +++ b/CRM/Core/Lock.php @@ -48,7 +48,7 @@ class CRM_Core_Lock { * e.g. civimail.cronjob.JOB_ID * @param int $timeout the number of seconds to wait to get the lock. 1 if not set * @param boolean $serverWideLock should this lock be applicable across your entire mysql server - * this is useful if you have mutliple sites running on the same + * this is useful if you have multiple sites running on the same * mysql server and you want to limit the number of parallel cron * jobs - CRM-91XX * diff --git a/CRM/Core/Permission/DrupalBase.php b/CRM/Core/Permission/DrupalBase.php index 4991d13499..1030904ae4 100644 --- a/CRM/Core/Permission/DrupalBase.php +++ b/CRM/Core/Permission/DrupalBase.php @@ -66,7 +66,7 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { * for this user * * @param string $groupType type of group(Access/Mailing) - * @param bool|\boolen $excludeHidden exclude hidden groups. + * @param bool $excludeHidden exclude hidden groups. * * @access public * diff --git a/CRM/Core/Smarty.php b/CRM/Core/Smarty.php index 1c7d6875db..a29d2e231f 100644 --- a/CRM/Core/Smarty.php +++ b/CRM/Core/Smarty.php @@ -48,7 +48,7 @@ class CRM_Core_Smarty extends Smarty { CONST // use print.tpl and bypass the CMS. Civi prints a valid html file PRINT_PAGE = 1, - // this and all the below bypasses the CMS html surronding it and assumes we will embed this within other pages + // this and all the below bypasses the CMS html surrounding it and assumes we will embed this within other pages PRINT_SNIPPET = 2, // sends the generated html to the chosen pdf engine PRINT_PDF = 3, diff --git a/CRM/Core/StateMachine.php b/CRM/Core/StateMachine.php index 0e4d57cc3d..b1cd60f620 100644 --- a/CRM/Core/StateMachine.php +++ b/CRM/Core/StateMachine.php @@ -87,7 +87,7 @@ class CRM_Core_StateMachine { * * @param object $controller the controller for this state machine * - * @param const $action + * @param \const|int $action * * @return \CRM_Core_StateMachine @access public -- 2.25.1