Commit 0880a9d0 authored by Eileen McNaughton's avatar Eileen McNaughton

INFRA-132 add full-stops after comments

parent eceb18cc
......@@ -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
......
......@@ -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;
......
......@@ -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
......
......@@ -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.
......
......@@ -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
......
......@@ -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() {
......
......@@ -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
*/
......
......@@ -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();
......
......@@ -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
......
......@@ -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;
......
......@@ -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
......
......@@ -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
......
......@@ -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() {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment