From 0880a9d0d6279d30564131892c9d71c2a3bb5903 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Wed, 4 Feb 2015 13:08:49 +1300 Subject: [PATCH] INFRA-132 add full-stops after comments --- CRM/Batch/Form/Entry.php | 4 ++-- CRM/Core/BAO/Note.php | 2 +- CRM/Core/BAO/OptionValue.php | 2 +- CRM/Core/BAO/Persistent.php | 2 +- CRM/Core/BAO/Setting.php | 2 +- CRM/Core/CodeGen/Util/Template.php | 2 +- CRM/Core/CommunityMessages.php | 8 ++++---- CRM/Core/Component.php | 4 ++-- CRM/Core/Component/Info.php | 4 ++-- CRM/Core/Config.php | 20 ++++++++++---------- CRM/Core/Controller.php | 30 +++++++++++++++--------------- CRM/Core/Error.php | 26 +++++++++++++------------- CRM/Core/Exception.php | 2 +- 13 files changed, 54 insertions(+), 54 deletions(-) diff --git a/CRM/Batch/Form/Entry.php b/CRM/Batch/Form/Entry.php index 254ab79447..b6c9741477 100755 --- a/CRM/Batch/Form/Entry.php +++ b/CRM/Batch/Form/Entry.php @@ -71,12 +71,12 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form { protected $_preserveDefault = TRUE; /** - * Contact fields + * Contact fields. */ protected $_contactFields = array(); /** - * Fields array of fields in the batch profile + * Fields array of fields in the batch profile. * (based on the uf_field table data) * (this can't be protected as it is passed into the CRM_Contact_Form_Task_Batch::parseStreetAddress function * (although a future refactoring might hopefully change that so it uses the api & the function is not diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index 08ad15333b..1212c8e5cf 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -39,7 +39,7 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { /** - * Const the max number of notes we display at any given time + * Const the max number of notes we display at any given time. * @var int */ const MAX_NOTES = 3; diff --git a/CRM/Core/BAO/OptionValue.php b/CRM/Core/BAO/OptionValue.php index f0ce92cbfc..711d4c80e3 100644 --- a/CRM/Core/BAO/OptionValue.php +++ b/CRM/Core/BAO/OptionValue.php @@ -105,7 +105,7 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { } /** - * Get next available value + * Get next available value. * We will take the highest numeric value (or 0 if no numeric values exist) * and add one. The calling function is responsible for any * more complex decision making diff --git a/CRM/Core/BAO/Persistent.php b/CRM/Core/BAO/Persistent.php index 467dca9958..ae6e833d93 100644 --- a/CRM/Core/BAO/Persistent.php +++ b/CRM/Core/BAO/Persistent.php @@ -35,7 +35,7 @@ class CRM_Core_BAO_Persistent extends CRM_Core_DAO_Persistent { /** - * Fetch object based on array of properties + * Fetch object based on array of properties. * * @param array $params * (reference ) an assoc array of name/value pairs. diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index 14d45628ca..7b064345a3 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -749,7 +749,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * Look for any missing settings and convert them from config or load default as appropriate + * Look for any missing settings and convert them from config or load default as appropriate. * This should be run from GenCode & also from upgrades to add any new defaults. * * Multisites have often been overlooked in upgrade scripts so can be expected to be missing diff --git a/CRM/Core/CodeGen/Util/Template.php b/CRM/Core/CodeGen/Util/Template.php index 76042b2a7d..2590301c34 100644 --- a/CRM/Core/CodeGen/Util/Template.php +++ b/CRM/Core/CodeGen/Util/Template.php @@ -83,7 +83,7 @@ class CRM_Core_CodeGen_Util_Template { } /** - * Clear the smarty cache and assign default values + * Clear the smarty cache and assign default values. * FIXME: unused cos we no longer do evil singleton magick */ protected function reset() { diff --git a/CRM/Core/CommunityMessages.php b/CRM/Core/CommunityMessages.php index 3db8215098..0141d7cedf 100644 --- a/CRM/Core/CommunityMessages.php +++ b/CRM/Core/CommunityMessages.php @@ -34,7 +34,7 @@ class CRM_Core_CommunityMessages { const DEFAULT_PERMISSION = 'administer CiviCRM'; /** - * Default time to wait before retrying + * Default time to wait before retrying. */ const DEFAULT_RETRY = 7200; // 2 hours @@ -54,7 +54,7 @@ class CRM_Core_CommunityMessages { protected $messagesUrl; /** - * Create default instance + * Create default instance. * * @return CRM_Core_CommunityMessages */ @@ -127,7 +127,7 @@ class CRM_Core_CommunityMessages { } /** - * Download document from URL and parse as JSON + * Download document from URL and parse as JSON. * * @return NULL|array * parsed JSON @@ -161,7 +161,7 @@ class CRM_Core_CommunityMessages { } /** - * Pick a message to display + * Pick a message to display. * * @return NULL|array */ diff --git a/CRM/Core/Component.php b/CRM/Core/Component.php index 0cc72ce62c..8a70a59a10 100644 --- a/CRM/Core/Component.php +++ b/CRM/Core/Component.php @@ -420,7 +420,7 @@ class CRM_Core_Component { } /** - * Handle table dependencies of components + * Handle table dependencies of components. * * @param array $tables * Array of tables. @@ -438,7 +438,7 @@ class CRM_Core_Component { } /** - * Get components info from info file + * Get components info from info file. */ public static function getComponentsFromFile($crmFolderDir) { $components = array(); diff --git a/CRM/Core/Component/Info.php b/CRM/Core/Component/Info.php index 882502ddb8..0059dc4e6c 100644 --- a/CRM/Core/Component/Info.php +++ b/CRM/Core/Component/Info.php @@ -185,7 +185,7 @@ abstract class CRM_Core_Component_Info { } /** - * Provides information about user dashboard element + * Provides information about user dashboard element. * offered by this component. * * @return array|null @@ -195,7 +195,7 @@ abstract class CRM_Core_Component_Info { abstract public function getUserDashboardElement(); /** - * Provides information about user dashboard element + * Provides information about user dashboard element. * offered by this component. * * @return array|null diff --git a/CRM/Core/Config.php b/CRM/Core/Config.php index b53adaef3c..f4f909e450 100644 --- a/CRM/Core/Config.php +++ b/CRM/Core/Config.php @@ -91,7 +91,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { public $userPermissionClass; /** - * The root directory where Smarty should store compiled files + * The root directory where Smarty should store compiled files. * * @var string */ @@ -667,7 +667,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * Verify that the needed parameters are not null in the config + * Verify that the needed parameters are not null in the config. * * @param CRM_Core_Config $config (reference) the system config object * @param array $required (reference) the parameters that need a value @@ -684,7 +684,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * Reset the serialized array and recompute + * Reset the serialized array and recompute. * use with care */ public function reset() { @@ -693,7 +693,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * This method should initialize auth sources + * This method should initialize auth sources. */ public function initAuthSrc() { $session = CRM_Core_Session::singleton(); @@ -706,7 +706,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * One function to get domain ID + * One function to get domain ID. */ public static function domainID($domainID = NULL, $reset = FALSE) { static $domain; @@ -768,7 +768,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * Flush information about loaded modules + * Flush information about loaded modules. */ public function clearModuleList() { CRM_Extension_System::singleton()->getCache()->flush(); @@ -778,7 +778,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * Clear db cache + * Clear db cache. */ public static function clearDBCache() { $queries = array( @@ -802,7 +802,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { } /** - * Clear leftover temporary tables + * Clear leftover temporary tables. */ public static function clearTempTables() { // CRM-5645 @@ -833,7 +833,7 @@ AND } /** - * Check if running in upgrade mode + * Check if running in upgrade mode. */ public static function isUpgradeMode($path = NULL) { if (defined('CIVICRM_UPGRADE_ACTIVE')) { @@ -859,7 +859,7 @@ AND } /** - * Wrapper function to allow unit tests to switch user framework on the fly + * Wrapper function to allow unit tests to switch user framework on the fly. */ public function setUserFramework($userFramework = NULL) { $this->userFramework = $userFramework; diff --git a/CRM/Core/Controller.php b/CRM/Core/Controller.php index db8a6ed443..7276ab5bd5 100644 --- a/CRM/Core/Controller.php +++ b/CRM/Core/Controller.php @@ -408,7 +408,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Getter method for stateMachine + * Getter method for stateMachine. * * @return CRM_Core_StateMachine */ @@ -417,7 +417,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Setter method for stateMachine + * Setter method for stateMachine. * * @param CRM_Core_StateMachine $stateMachine * @@ -515,7 +515,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Store the variable with the value in the form scope + * Store the variable with the value in the form scope. * * @param string|array $name name of the variable or an assoc array of name/value pairs * @param mixed $value @@ -529,7 +529,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Get the variable from the form scope + * Get the variable from the form scope. * * @param string $name * name of the variable. @@ -542,7 +542,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Create the header for the wizard from the list of pages + * Create the header for the wizard from the list of pages. * Store the created header in smarty * * @param string $currentPageName @@ -599,7 +599,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Assign value to name in template + * Assign value to name in template. * * @param string $var * @param mixed $value @@ -612,7 +612,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Assign value to name in template by reference + * Assign value to name in template by reference. * * @param string $var * @param mixed $value @@ -625,7 +625,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Appends values to template variables + * Appends values to template variables. * * @param array|string $tpl_var the template variable name(s) * @param mixed $value @@ -637,7 +637,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Returns an array containing template variables + * Returns an array containing template variables. * * @param string $name * @@ -648,7 +648,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Setter for embedded + * Setter for embedded. * * @param bool $embedded * @@ -659,7 +659,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Getter for embedded + * Getter for embedded. * * @return bool * return the embedded value @@ -669,7 +669,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Setter for skipRedirection + * Setter for skipRedirection. * * @param bool $skipRedirection * @@ -680,7 +680,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Getter for skipRedirection + * Getter for skipRedirection. * * @return bool * return the skipRedirection value @@ -719,7 +719,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Setter for print + * Setter for print. * * @param bool $print * @@ -736,7 +736,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { } /** - * Getter for print + * Getter for print. * * @return bool * return the print value diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php index 42c614e8f4..d3147a8e0f 100644 --- a/CRM/Core/Error.php +++ b/CRM/Core/Error.php @@ -73,7 +73,7 @@ class CRM_Exception extends PEAR_Exception { class CRM_Core_Error extends PEAR_ErrorStack { /** - * Status code of various types of errors + * Status code of various types of errors. */ const FATAL_ERROR = 2; const DUPLICATE_CONTACT = 8001; @@ -117,7 +117,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Constructor + * Constructor. */ public function __construct() { parent::__construct('CiviCRM'); @@ -149,7 +149,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Status display function specific to payment processor errors + * Status display function specific to payment processor errors. * @param $error * @param string $separator */ @@ -292,7 +292,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Display an error page with an error message describing what happened + * Display an error page with an error message describing what happened. * * @param string $message * The error message. @@ -381,7 +381,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Display an error page with an error message describing what happened + * Display an error page with an error message describing what happened. * * This function is evil -- it largely replicates fatal(). Hopefully the * entire CRM_Core_Error system can be hollowed out and replaced with @@ -560,7 +560,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Display the error message on terminal + * Display the error message on terminal. * * @param $message * @param bool $out @@ -623,7 +623,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Obtain a reference to the error log + * Obtain a reference to the error log. * * @param string $comp * @@ -673,7 +673,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Render a backtrace array as a string + * Render a backtrace array as a string. * * @param array $backTrace * Array of stack frames. @@ -694,7 +694,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Render a backtrace array as an array + * Render a backtrace array as an array. * * @param array $backTrace * Array of stack frames. @@ -772,7 +772,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Render an exception as HTML string + * Render an exception as HTML string. * * @param Exception $e * @return string @@ -808,7 +808,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Write details of an exception to the log + * Write details of an exception to the log. * * @param Exception $e * @return string @@ -870,7 +870,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Reset the error stack + * Reset the error stack. * */ public static function reset() { @@ -944,7 +944,7 @@ class CRM_Core_Error extends PEAR_ErrorStack { } /** - * Terminate execution abnormally + * Terminate execution abnormally. */ protected static function abend($code) { // do a hard rollback of any pending transactions diff --git a/CRM/Core/Exception.php b/CRM/Core/Exception.php index 13f4e2d191..2722c6b73b 100644 --- a/CRM/Core/Exception.php +++ b/CRM/Core/Exception.php @@ -52,7 +52,7 @@ class CRM_Core_Exception extends PEAR_Exception { } /** - * custom string representation of object + * custom string representation of object. * @return string */ public function __toString() { -- 2.25.1