From 616eac7ecb504c8b1b516e7ab17538fade798138 Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Tue, 1 Sep 2015 00:31:59 +1200 Subject: [PATCH] comment fixes --- CRM/Contact/Import/ImportJob.php | 4 +--- CRM/Contact/Import/Importer.php | 2 -- CRM/Contact/Import/Page/AJAX.php | 4 +--- CRM/Contact/Import/Parser.php | 14 +------------- CRM/Contact/Import/Parser/Contact.php | 8 +------- CRM/Contact/Page/CustomSearch.php | 5 ----- CRM/Contact/Page/DashBoard.php | 7 +------ CRM/Contact/Page/Dashlet.php | 7 +------ CRM/Contact/Page/DedupeException.php | 8 ++------ 9 files changed, 8 insertions(+), 51 deletions(-) diff --git a/CRM/Contact/Import/ImportJob.php b/CRM/Contact/Import/ImportJob.php index c9696e94b7..d1b9efdbe4 100644 --- a/CRM/Contact/Import/ImportJob.php +++ b/CRM/Contact/Import/ImportJob.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class acts like a psuedo-BAO for transient import job tables + * This class acts like a psuedo-BAO for transient import job tables. */ class CRM_Contact_Import_ImportJob { diff --git a/CRM/Contact/Import/Importer.php b/CRM/Contact/Import/Importer.php index 3ec69f117b..90088f6be2 100644 --- a/CRM/Contact/Import/Importer.php +++ b/CRM/Contact/Import/Importer.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Contact/Import/Page/AJAX.php b/CRM/Contact/Import/Page/AJAX.php index d8ee4c0d32..50ac2f340b 100644 --- a/CRM/Contact/Import/Page/AJAX.php +++ b/CRM/Contact/Import/Page/AJAX.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class contains all the function that are called using AJAX + * This class contains all the function that are called using AJAX. */ class CRM_Contact_Import_Page_AJAX { diff --git a/CRM/Contact/Import/Parser.php b/CRM/Contact/Import/Parser.php index 2550ec9bc9..ba3a50865e 100644 --- a/CRM/Contact/Import/Parser.php +++ b/CRM/Contact/Import/Parser.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { @@ -455,8 +453,6 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { * * @param array $elements * IM service provider type ids. - * - * @return void */ public function setActiveFieldImProviders($elements) { for ($i = 0; $i < count($elements); $i++) { @@ -523,8 +519,6 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { * * @param array $elements * IM service provider type ids of related contact. - * - * @return void */ public function setActiveFieldRelatedContactImProvider($elements) { for ($i = 0; $i < count($elements); $i++) { @@ -667,8 +661,6 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { * @param CRM_Core_Session $store * * @param int $mode - * - * @return void */ public function set($store, $mode = self::MODE_SUMMARY) { $store->set('rowCount', $this->_rowCount); @@ -731,9 +723,7 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { * @param string $fileName * @param array $header * @param array $data - * - * @return void - */ + */ public static function exportCSV($fileName, $header, $data) { if (file_exists($fileName) && !is_writable($fileName)) { @@ -778,8 +768,6 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { * * @param int $id * @param array $params - * - * @return void */ public function updateImportRecord($id, &$params) { $statusFieldName = $this->_statusFieldName; diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php index 2a7a90f30a..4cc793b549 100644 --- a/CRM/Contact/Import/Parser/Contact.php +++ b/CRM/Contact/Import/Parser/Contact.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ //@todo calling api functions directly is not supported @@ -125,8 +123,6 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * The initializer code, called before the processing - * - * @return void */ public function init() { $contactFields = CRM_Contact_BAO_Contact::importableFields($this->_contactType); @@ -1091,9 +1087,7 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { } /** - * The initializer code, called before the processing - * - * @return void + * The initializer code, called before the processing. */ public function fini() { } diff --git a/CRM/Contact/Page/CustomSearch.php b/CRM/Contact/Page/CustomSearch.php index 64a39ae464..c0c7499ef5 100644 --- a/CRM/Contact/Page/CustomSearch.php +++ b/CRM/Contact/Page/CustomSearch.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * Main page for viewing all Saved searches. - * */ class CRM_Contact_Page_CustomSearch extends CRM_Core_Page { @@ -89,8 +86,6 @@ ORDER By v.weight /** * Run this page (figure out the action needed and perform it). - * - * @return void */ public function run() { $action = CRM_Utils_Request::retrieve('action', diff --git a/CRM/Contact/Page/DashBoard.php b/CRM/Contact/Page/DashBoard.php index ed97dbc589..3e50cd5cfe 100644 --- a/CRM/Contact/Page/DashBoard.php +++ b/CRM/Contact/Page/DashBoard.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * CiviCRM Dashboard - * + * CiviCRM Dashboard. */ class CRM_Contact_Page_DashBoard extends CRM_Core_Page { /** * Run dashboard. - * - * @return void */ public function run() { // Add dashboard js and css diff --git a/CRM/Contact/Page/Dashlet.php b/CRM/Contact/Page/Dashlet.php index deae061a2b..721e0559cd 100644 --- a/CRM/Contact/Page/Dashlet.php +++ b/CRM/Contact/Page/Dashlet.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * CiviCRM Dashlet - * + * CiviCRM Dashlet. */ class CRM_Contact_Page_Dashlet extends CRM_Core_Page { /** * Run dashboard. - * - * @return void */ public function run() { CRM_Utils_System::setTitle(ts('Dashlets')); diff --git a/CRM/Contact/Page/DedupeException.php b/CRM/Contact/Page/DedupeException.php index ea75e24af5..3ce43ca50b 100644 --- a/CRM/Contact/Page/DedupeException.php +++ b/CRM/Contact/Page/DedupeException.php @@ -29,21 +29,17 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * Main page for viewing contact. - * */ class CRM_Contact_Page_DedupeException extends CRM_Core_Page { /** - * Heart of the viewing process. The runner gets all the meta data for - * the contact and calls the appropriate type of page to view. + * Heart of the viewing process. * - * @return void + * The runner gets all the meta data for the contact and calls the appropriate type of page to view. */ public function preProcess() { //fetch the dedupe exception contacts. -- 2.25.1