From b8c71ffad7039cbda80a8c35f6d06e5d4e31ca75 Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Thu, 3 Sep 2015 20:38:35 +1200 Subject: [PATCH] comment fixes --- CRM/Import/DataSource/CSV.php | 10 +++------- CRM/Pledge/Form/Task.php | 12 +----------- CRM/SMS/Form/Upload.php | 10 +--------- CRM/Utils/Cache/Interface.php | 6 ------ CRM/Utils/Hook.php | 10 ++++------ CRM/Utils/ICalendar.php | 5 ----- CRM/Utils/Mail/EmailProcessor.php | 14 +++----------- CRM/Utils/Migrate/Export.php | 10 +++------- CRM/Utils/Migrate/Import.php | 10 ++++------ CRM/Utils/OptionBag.php | 4 +--- CRM/Utils/Pager.php | 9 ++------- CRM/Utils/PseudoConstant.php | 11 +++++------ CRM/Utils/Recent.php | 12 +----------- CRM/Utils/SoapServer.php | 11 ----------- CRM/Utils/Sort.php | 14 +++++--------- CRM/Utils/System.php | 5 +---- CRM/Utils/System/Drupal.php | 6 ------ CRM/Utils/System/Drupal6.php | 20 ++++++++------------ CRM/Utils/System/Joomla.php | 9 ++------- CRM/Utils/System/Soap.php | 6 +----- CRM/Utils/Token.php | 6 +----- CRM/Utils/Tree.php | 14 ++++---------- CRM/Utils/Wrapper.php | 4 +--- Civi/CCase/Analyzer.php | 2 -- Civi/Core/Lock/NullLock.php | 10 ++++++++-- bin/ContributionProcessor.php | 2 -- bin/encryptDB.php | 2 -- bin/migrate/export.php | 2 -- bin/migrate/exportJSON.php | 2 -- bin/migrate/import.php | 2 -- bin/migrate/importJSON.php | 2 -- bin/migrate/move.php | 2 -- 32 files changed, 59 insertions(+), 185 deletions(-) diff --git a/CRM/Import/DataSource/CSV.php b/CRM/Import/DataSource/CSV.php index 57aea4ab91..54218d7fa1 100644 --- a/CRM/Import/DataSource/CSV.php +++ b/CRM/Import/DataSource/CSV.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { const @@ -53,14 +51,12 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { } /** - * This is function is called by the form object to get the DataSource's - * form snippet. It should add all fields necesarry to get the data + * This is function is called by the form object to get the DataSource's form snippet. + * + * It should add all fields necessary to get the data * uploaded to the temporary table in the DB. * * @param CRM_Core_Form $form - * - * @return void - * (operates directly on form argument) */ public function buildQuickForm(&$form) { $form->add('hidden', 'hidden_dataSource', 'CRM_Import_DataSource_CSV'); diff --git a/CRM/Pledge/Form/Task.php b/CRM/Pledge/Form/Task.php index 14175f212e..7aac36e1d3 100644 --- a/CRM/Pledge/Form/Task.php +++ b/CRM/Pledge/Form/Task.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates task actions for CiviEvent - * + * This class generates task actions for CiviEvent. */ class CRM_Pledge_Form_Task extends CRM_Core_Form { @@ -69,10 +66,6 @@ class CRM_Pledge_Form_Task extends CRM_Core_Form { /** * Build all the data structures needed to build the form. - * - * @param - * - * @return void */ public function preProcess() { self::preProcessCommon($this); @@ -154,9 +147,6 @@ class CRM_Pledge_Form_Task extends CRM_Core_Form { * @param string $nextType * @param string $backType * @param bool $submitOnce - * - * - * @return void */ public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) { $this->addButtons(array( diff --git a/CRM/SMS/Form/Upload.php b/CRM/SMS/Form/Upload.php index 64a21bc405..d2c471f844 100644 --- a/CRM/SMS/Form/Upload.php +++ b/CRM/SMS/Form/Upload.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This file is used to build the form configuring mass sms details + * This file is used to build the form configuring mass sms details. */ class CRM_SMS_Form_Upload extends CRM_Core_Form { public $_mailingID; @@ -48,10 +46,6 @@ class CRM_SMS_Form_Upload extends CRM_Core_Form { /** * Set default values for the form. - * the default values are retrieved from the database - * - * - * @return void */ public function setDefaultValues() { $mailingID = CRM_Utils_Request::retrieve('mid', 'Integer', $this, FALSE, NULL); @@ -120,8 +114,6 @@ class CRM_SMS_Form_Upload extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $session = CRM_Core_Session::singleton(); diff --git a/CRM/Utils/Cache/Interface.php b/CRM/Utils/Cache/Interface.php index 00449c71f8..4363d51f6f 100644 --- a/CRM/Utils/Cache/Interface.php +++ b/CRM/Utils/Cache/Interface.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ interface CRM_Utils_Cache_Interface { @@ -39,7 +37,6 @@ interface CRM_Utils_Cache_Interface { * * @param string $key * @param mixed $value - * @return void */ public function set($key, &$value); @@ -56,14 +53,11 @@ interface CRM_Utils_Cache_Interface { * Delete a value from the cache. * * @param string $key - * @return void */ public function delete($key); /** * Delete all values from the cache. - * - * @return void */ public function flush(); diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php index 7f47c22a48..8d2ccc633b 100644 --- a/CRM/Utils/Hook.php +++ b/CRM/Utils/Hook.php @@ -29,8 +29,6 @@ * * @package CiviCRM_Hook * @copyright CiviCRM LLC (c) 2004-2015 - * $Id: $ - * */ abstract class CRM_Utils_Hook { @@ -1168,7 +1166,7 @@ abstract class CRM_Utils_Hook { * fieldHeaders - field headers * fields - import fields * - * @return void + * @return mixed */ public static function import($object, $usage, &$objectRef, &$params) { return self::singleton()->invoke(4, $object, $usage, $objectRef, $params, @@ -1245,7 +1243,7 @@ abstract class CRM_Utils_Hook { * @param array $selector * the selector object. Allows you access to the context of the search * - * @return void + * @return mixed * modify the header and values object to pass the data u need */ public static function searchColumns($objectName, &$headers, &$rows, &$selector) { @@ -1783,7 +1781,7 @@ abstract class CRM_Utils_Hook { * @param int $otherCaseId * @param bool $changeClient * - * @return void + * @return mixed */ public static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) { return self::singleton() @@ -1799,7 +1797,7 @@ abstract class CRM_Utils_Hook { * @param int $otherCaseId * @param bool $changeClient * - * @return void + * @return mixed */ public static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) { return self::singleton() diff --git a/CRM/Utils/ICalendar.php b/CRM/Utils/ICalendar.php index ea56475451..bae913ed9d 100644 --- a/CRM/Utils/ICalendar.php +++ b/CRM/Utils/ICalendar.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -38,7 +36,6 @@ * API for event export in iCalendar format * as outlined in Internet Calendaring and * Scheduling Core Object Specification - * */ class CRM_Utils_ICalendar { @@ -103,8 +100,6 @@ class CRM_Utils_ICalendar { * The file name (for downloads). * @param string $disposition * How the file should be sent ('attachment' for downloads). - * - * @return void */ public static function send($calendar, $content_type = 'text/calendar', $charset = 'us-ascii', $fileName = NULL, $disposition = NULL) { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Utils/Mail/EmailProcessor.php b/CRM/Utils/Mail/EmailProcessor.php index db9a23e70d..7450684b7b 100644 --- a/CRM/Utils/Mail/EmailProcessor.php +++ b/CRM/Utils/Mail/EmailProcessor.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ // we should consider moving these to the settings table @@ -39,7 +37,7 @@ define('EMAIL_ACTIVITY_TYPE_ID', NULL); define('MAIL_BATCH_SIZE', 50); /** - * Class CRM_Utils_Mail_EmailProcessor + * Class CRM_Utils_Mail_EmailProcessor. */ class CRM_Utils_Mail_EmailProcessor { @@ -65,14 +63,12 @@ class CRM_Utils_Mail_EmailProcessor { } /** - * Delete old files from a given directory (recursively) + * Delete old files from a given directory (recursively). * * @param string $dir * Directory to cleanup. * @param int $age * Files older than this many seconds will be deleted (default: 60 days). - * - * @return void */ public static function cleanupDir($dir, $age = 5184000) { // return early if we can’t read/write the dir @@ -96,9 +92,7 @@ class CRM_Utils_Mail_EmailProcessor { } /** - * Process the mailboxes that aren't default (ie. that aren't used by civiMail for the bounce) - * - * @return void + * Process the mailboxes that aren't default (ie. that aren't used by civiMail for the bounce). */ public static function processActivities() { $dao = new CRM_Core_DAO_MailSettings(); @@ -120,8 +114,6 @@ class CRM_Utils_Mail_EmailProcessor { * Process the mailbox for all the settings from civicrm_mail_settings. * * @param bool|string $civiMail if true, processing is done in CiviMail context, or Activities otherwise. - * - * @return void */ public static function process($civiMail = TRUE) { $dao = new CRM_Core_DAO_MailSettings(); diff --git a/CRM/Utils/Migrate/Export.php b/CRM/Utils/Migrate/Export.php index 3b66f0dcbb..f0e584cb9c 100644 --- a/CRM/Utils/Migrate/Export.php +++ b/CRM/Utils/Migrate/Export.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Utils_Migrate_Export { @@ -166,9 +164,7 @@ class CRM_Utils_Migrate_Export { } /** - * Scan local customizations and build an in-memory representation - * - * @return void + * Scan local customizations and build an in-memory representation. */ public function build() { // fetch the option group / values for @@ -266,9 +262,10 @@ class CRM_Utils_Migrate_Export { } /** + * Build custom groups. + * * @param array $customGroupIds * List of custom groups to export. - * @return void */ public function buildCustomGroups($customGroupIds) { $customGroupIdsSql = implode(',', array_filter($customGroupIds, 'is_numeric')); @@ -322,7 +319,6 @@ class CRM_Utils_Migrate_Export { /** * @param array $ufGroupIds * List of custom groups to export. - * @return void */ public function buildUFGroups($ufGroupIds) { $ufGroupIdsSql = implode(',', array_filter($ufGroupIds, 'is_numeric')); diff --git a/CRM/Utils/Migrate/Import.php b/CRM/Utils/Migrate/Import.php index fc0e096988..9f09ccd938 100644 --- a/CRM/Utils/Migrate/Import.php +++ b/CRM/Utils/Migrate/Import.php @@ -29,22 +29,21 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Utils_Migrate_Import { /** + * Class constructor. */ public function __construct() { } /** - * Import custom-data from an XML file + * Import custom-data from an XML file. * * @param string $file * Path to an XML file. + * * @throws CRM_Core_Exception - * @return void; */ public function run($file) { // read xml file @@ -58,10 +57,9 @@ class CRM_Utils_Migrate_Import { } /** - * Import custom-data from an XML element + * Import custom-data from an XML element. * * @param SimpleXMLElement $xml - * @return void */ public function runXmlElement($xml) { $idMap = array( diff --git a/CRM/Utils/OptionBag.php b/CRM/Utils/OptionBag.php index fe87d41027..4149cd272a 100644 --- a/CRM/Utils/OptionBag.php +++ b/CRM/Utils/OptionBag.php @@ -1,7 +1,7 @@ . * The value to set. *

- * @return void */ public function offsetSet($offset, $value) { $this->data[$offset] = $value; @@ -113,7 +112,6 @@ class CRM_Utils_OptionBag implements ArrayAccess, IteratorAggregate, Countable { *

. * The offset to unset. *

- * @return void */ public function offsetUnset($offset) { unset($this->data[$offset]); diff --git a/CRM/Utils/Pager.php b/CRM/Utils/Pager.php index 6eb114209a..9f8d87e867 100644 --- a/CRM/Utils/Pager.php +++ b/CRM/Utils/Pager.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -40,7 +38,6 @@ * use a POST to jump to a specific page). At some point we should evaluate if we want * to use Pager_Jumping instead. We've changed the format to allow navigation by jumping * to a page and also First, Prev CURRENT Next Last - * */ require_once 'Pager/Sliding.php'; @@ -131,11 +128,9 @@ class CRM_Utils_Pager extends Pager_Sliding { * values. * * @param array $params - * The set of options needed to initialize the parent. - * constructor + * The set of options needed to initialize the parent constructor. * - * - * @return void + * @return array */ public function initialize(&$params) { /* set the mode for the pager to Sliding */ diff --git a/CRM/Utils/PseudoConstant.php b/CRM/Utils/PseudoConstant.php index 9958d5adbc..be85fe6bde 100644 --- a/CRM/Utils/PseudoConstant.php +++ b/CRM/Utils/PseudoConstant.php @@ -26,7 +26,7 @@ */ /** - * Utilities for manipulating/inspecting CRM_*_PseudoConstant classes + * Utilities for manipulating/inspecting CRM_*_PseudoConstant classes. */ class CRM_Utils_PseudoConstant { /** @@ -49,10 +49,10 @@ class CRM_Utils_PseudoConstant { * * Wrapper for Pseudoconstant methods. We use this so the calling function * doesn't need to know which class the Pseudoconstant is on - * (some are on the Contribute_Pseudoconsant Class etc + * (some are on the Contribute_Pseudoconstant Class etc * * - * @param $constant + * @param string $constant * * @return array * array reference of all relevant constant @@ -155,10 +155,9 @@ class CRM_Utils_PseudoConstant { } /** - * Flush all caches related to pseudo-constants. This may be inefficient - * and should generally be avoided. + * Flush all caches related to pseudo-constants. * - * @return void + * This may be inefficient and should generally be avoided. */ public static function flushAll() { foreach (self::findConstants() as $constant) { diff --git a/CRM/Utils/Recent.php b/CRM/Utils/Recent.php index 61c3b5a163..d73825dbc5 100644 --- a/CRM/Utils/Recent.php +++ b/CRM/Utils/Recent.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * + * Recent items utility class. */ class CRM_Utils_Recent { @@ -54,8 +52,6 @@ class CRM_Utils_Recent { /** * Initialize this class and set the static variables. - * - * @return void */ public static function initialize() { if (!self::$_recent) { @@ -91,8 +87,6 @@ class CRM_Utils_Recent { * @param int $contactId * @param string $contactName * @param array $others - * - * @return void */ public static function add( $title, @@ -148,8 +142,6 @@ class CRM_Utils_Recent { * * @param array $recentItem * Array of the recent Item to be removed. - * - * @return void */ public static function del($recentItem) { self::initialize(); @@ -176,8 +168,6 @@ class CRM_Utils_Recent { * * @param string $id * Contact id that had to be removed. - * - * @return void */ public static function delContact($id) { self::initialize(); diff --git a/CRM/Utils/SoapServer.php b/CRM/Utils/SoapServer.php index c4b969761d..cdf85618a0 100644 --- a/CRM/Utils/SoapServer.php +++ b/CRM/Utils/SoapServer.php @@ -25,21 +25,11 @@ +--------------------------------------------------------------------+ */ -/** - * - * @package CRM - * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * - */ - /** * This class handles all SOAP client requests. * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Utils_SoapServer { @@ -88,7 +78,6 @@ class CRM_Utils_SoapServer { * The soap key generated by authenticate(). * * @throws SoapFault - * @return void */ public function verify($key) { $session = CRM_Core_Session::singleton(); diff --git a/CRM/Utils/Sort.php b/CRM/Utils/Sort.php index 5518f4d01b..098ef0e4e6 100644 --- a/CRM/Utils/Sort.php +++ b/CRM/Utils/Sort.php @@ -29,15 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * - * Base class to provide generic sort functionality. Note that some ideas - * have been borrowed from the drupal tablesort.inc code. Also note that - * since the Pager and Sort class are similar, do match the function names + * Base class to provide generic sort functionality. + * + * Note that some ideas have been borrowed from the drupal tablesort.inc code. + * + * Also note that since the Pager and Sort class are similar, do match the function names * if introducing additional functionality * * @package CRM @@ -188,8 +188,6 @@ class CRM_Utils_Sort { * * @param string $defaultSortOrder * The sort order to use by default. - * - * @return void */ public function initSortID($defaultSortOrder) { $url = CRM_Utils_Array::value(self::SORT_ID, $_GET, $defaultSortOrder); @@ -225,8 +223,6 @@ class CRM_Utils_Sort { * * @param string $defaultSortOrder * The sort order to use by default. - * - * @return void */ public function initialize($defaultSortOrder) { $this->initSortID($defaultSortOrder); diff --git a/CRM/Utils/System.php b/CRM/Utils/System.php index aa4ca4c567..a285329d97 100644 --- a/CRM/Utils/System.php +++ b/CRM/Utils/System.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * System wide utilities. - * */ class CRM_Utils_System { @@ -1307,7 +1304,7 @@ class CRM_Utils_System { * @param array $params * An array of parameters (see CRM_Utils_System::docURL2 method for names) * - * @return void|string + * @return null|string * URL or link to documentation page, based on provided parameters. */ public static function docURL($params) { diff --git a/CRM/Utils/System/Drupal.php b/CRM/Utils/System/Drupal.php index 75ed56e694..e0543b1959 100644 --- a/CRM/Utils/System/Drupal.php +++ b/CRM/Utils/System/Drupal.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -113,8 +111,6 @@ class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase { * Array of errors. * @param string $emailName * Field label for the 'email'. - * - * @return void */ public static function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') { $config = CRM_Core_Config::singleton(); @@ -699,8 +695,6 @@ AND u.status = 1 * @param string $oldPerm * @param array $newPerms * Array, strings. - * - * @return void */ public function replacePermission($oldPerm, $newPerms) { $roles = user_roles(FALSE, $oldPerm); diff --git a/CRM/Utils/System/Drupal6.php b/CRM/Utils/System/Drupal6.php index 7417c61a6b..935f0471e4 100644 --- a/CRM/Utils/System/Drupal6.php +++ b/CRM/Utils/System/Drupal6.php @@ -29,18 +29,17 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Drupal specific stuff goes here + * Drupal specific stuff goes here. */ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { /** - * If we are using a theming system, invoke theme, else just print the - * content + * Theme output. + * + * If we are using a theming system, invoke theme, else just print the content. * * @param string $content * The content that will be themed. @@ -49,7 +48,7 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * @param bool $maintenance * For maintenance mode. * - * @return void + * @return null|string * prints content on stdout */ public function theme(&$content, $print = FALSE, $maintenance = FALSE) { @@ -73,9 +72,12 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { } print $out; + return NULL; } /** + * Create user. + * * @inheritDoc */ public function createUser(&$params, $mail) { @@ -137,8 +139,6 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * Array of errors. * @param string $emailName * Field label for the 'email'. - * - * @return void */ public function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') { $config = CRM_Core_Config::singleton(); @@ -253,8 +253,6 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * * @param string $head * The new string to be appended. - * - * @return void */ public function addHTMLHead($head) { drupal_set_html_head($head); @@ -652,8 +650,6 @@ class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase { * @param string $oldPerm * @param array $newPerms * Array, strings. - * - * @return void */ public function replacePermission($oldPerm, $newPerms) { $roles = user_roles(FALSE, $oldPerm); diff --git a/CRM/Utils/System/Joomla.php b/CRM/Utils/System/Joomla.php index 4b780d84bc..0b7e13a351 100644 --- a/CRM/Utils/System/Joomla.php +++ b/CRM/Utils/System/Joomla.php @@ -29,15 +29,14 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Joomla specific stuff goes here + * Joomla specific stuff goes here. */ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { /** + * Class constructor. */ public function __construct() { /** @@ -117,8 +116,6 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * Array of errors. * @param string $emailName * Field label for the 'email'. - * - * @return void */ public function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') { $config = CRM_Core_Config::singleton(); @@ -318,8 +315,6 @@ class CRM_Utils_System_Joomla extends CRM_Utils_System_Base { * * @param object $user * Handle to the user object. - * - * @return void */ public function setEmail(&$user) { global $database; diff --git a/CRM/Utils/System/Soap.php b/CRM/Utils/System/Soap.php index 8f00c2cd32..d3b43a1e9a 100644 --- a/CRM/Utils/System/Soap.php +++ b/CRM/Utils/System/Soap.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Soap specific stuff goes here + * Soap specific stuff goes here. */ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { @@ -84,8 +82,6 @@ class CRM_Utils_System_Soap extends CRM_Utils_System_Base { * * @param object $user * Handle to the user object. - * - * @return void */ public function setEmail(&$user) { } diff --git a/CRM/Utils/Token.php b/CRM/Utils/Token.php index 13b4b1b29c..192fc5b97b 100644 --- a/CRM/Utils/Token.php +++ b/CRM/Utils/Token.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id: $ - * */ /** - * Class to abstract token replacement + * Class to abstract token replacement. */ class CRM_Utils_Token { static $_requiredTokens = NULL; @@ -866,8 +864,6 @@ class CRM_Utils_Token { * this routine will remove the extra backslashes and braces * * @param $str ref to the string that will be scanned and modified - * @return void - * this function works directly on the string that is passed */ public static function unescapeTokens(&$str) { $str = preg_replace('/\\\\|\{(\{\w+\.\w+\})\}/', '\\1', $str); diff --git a/CRM/Utils/Tree.php b/CRM/Utils/Tree.php index 78a84b6cb3..cc526ae474 100644 --- a/CRM/Utils/Tree.php +++ b/CRM/Utils/Tree.php @@ -29,13 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Manage simple Tree data structure - * example of Tree is + * Manage simple Tree data structure. + * + * Example of Tree is * * 'a' * | @@ -142,6 +141,7 @@ class CRM_Utils_Tree { /** * Check if node is a leaf node. + * * Currently leaf nodes are strings and non-leaf nodes are arrays * * @param array $node node which needs to checked @@ -174,8 +174,6 @@ class CRM_Utils_Tree { * @param string $parentName * Name of the parent ?. * @param array (ref) $node - node to be added - * - * @return void */ public function addNode($parentName, &$node) { $temp = ''; @@ -190,8 +188,6 @@ class CRM_Utils_Tree { * @param string $parentName Name of the parent ?. * @param string $childName - key to be used (optional) * @param mixed $data - data to be added - * - * @return void */ public function addData($parentName, $childName, $data) { $temp = ''; @@ -216,8 +212,6 @@ class CRM_Utils_Tree { /** * Print the tree. - * - * @return void */ public function display() { print_r($this->tree); diff --git a/CRM/Utils/Wrapper.php b/CRM/Utils/Wrapper.php index 31aed2c902..5211aa68f7 100644 --- a/CRM/Utils/Wrapper.php +++ b/CRM/Utils/Wrapper.php @@ -34,8 +34,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id: $ - * */ class CRM_Utils_Wrapper { @@ -59,7 +57,7 @@ class CRM_Utils_Wrapper { * - bool addSequence: should we add a unique sequence number to the end of the key * - bool ignoreKey: should we not set a qfKey for this controller (for standalone forms) * - * @return void + * @return mixed */ public function run($formName, $formLabel = NULL, $arguments = NULL) { if (is_array($arguments)) { diff --git a/Civi/CCase/Analyzer.php b/Civi/CCase/Analyzer.php index 6690495f4b..5ecf0fa9bc 100644 --- a/Civi/CCase/Analyzer.php +++ b/Civi/CCase/Analyzer.php @@ -216,8 +216,6 @@ class Analyzer { /** * Flush any cached information. - * - * @return void */ public function flush() { $this->case = NULL; diff --git a/Civi/Core/Lock/NullLock.php b/Civi/Core/Lock/NullLock.php index 428fc305c5..8691a69a18 100644 --- a/Civi/Core/Lock/NullLock.php +++ b/Civi/Core/Lock/NullLock.php @@ -30,15 +30,16 @@ namespace Civi\Core\Lock; * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class NullLock implements LockInterface { private $hasLock = FALSE; /** + * Create lock. + * * @param string $name + * * @return static */ public static function create($name) { @@ -46,9 +47,12 @@ class NullLock implements LockInterface { } /** + * Acquire lock. + * * @param int|NULL $timeout * The number of seconds to wait to get the lock. * For a default value, use NULL. + * * @return bool */ public function acquire($timeout = NULL) { @@ -57,6 +61,8 @@ class NullLock implements LockInterface { } /** + * Release lock. + * * @return bool|null|string * Trueish/falsish. */ diff --git a/bin/ContributionProcessor.php b/bin/ContributionProcessor.php index bf8096f964..5d007253d6 100644 --- a/bin/ContributionProcessor.php +++ b/bin/ContributionProcessor.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CiviContributeProcessor { static $_paypalParamsMapper = array( diff --git a/bin/encryptDB.php b/bin/encryptDB.php index ef1b5aa867..acbc7457d9 100644 --- a/bin/encryptDB.php +++ b/bin/encryptDB.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ define('CRM_ENCRYPT', 1); diff --git a/bin/migrate/export.php b/bin/migrate/export.php index 11197298c9..84470d5c34 100644 --- a/bin/migrate/export.php +++ b/bin/migrate/export.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ function run() { session_start(); diff --git a/bin/migrate/exportJSON.php b/bin/migrate/exportJSON.php index 7eadd53e74..d8dd24376a 100644 --- a/bin/migrate/exportJSON.php +++ b/bin/migrate/exportJSON.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ function run() { session_start(); diff --git a/bin/migrate/import.php b/bin/migrate/import.php index ed01236d90..4505eadb79 100644 --- a/bin/migrate/import.php +++ b/bin/migrate/import.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ function run() { session_start(); diff --git a/bin/migrate/importJSON.php b/bin/migrate/importJSON.php index e882ec4f06..75bfe307f6 100644 --- a/bin/migrate/importJSON.php +++ b/bin/migrate/importJSON.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ function run() { session_start(); diff --git a/bin/migrate/move.php b/bin/migrate/move.php index c09297b21d..6a94275f05 100644 --- a/bin/migrate/move.php +++ b/bin/migrate/move.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ function run() { session_start(); -- 2.25.1