From: eileenmcnaugton <eileen@fuzion.co.nz>
Date: Mon, 31 Aug 2015 12:31:16 +0000 (+1200)
Subject: comment fixes
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=f12c6f7d60028108303d01154168488042632d19;p=civicrm-core.git

comment fixes
---

diff --git a/CRM/Contact/Form/Task/SaveSearch.php b/CRM/Contact/Form/Task/SaveSearch.php
index 357d9a919e..cb3fd33f45 100644
--- a/CRM/Contact/Form/Task/SaveSearch.php
+++ b/CRM/Contact/Form/Task/SaveSearch.php
@@ -29,12 +29,11 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 
 /**
- * This class provides the functionality to save a search
+ * This class provides the functionality to save a search.
+ *
  * Saved Searches are used for saving frequently used queries
  */
 class CRM_Contact_Form_Task_SaveSearch extends CRM_Contact_Form_Task {
@@ -48,8 +47,6 @@ class CRM_Contact_Form_Task_SaveSearch extends CRM_Contact_Form_Task {
 
   /**
    * Build all the data structures needed to build the form.
-   *
-   * @return void
    */
   public function preProcess() {
     $this->_id = NULL;
@@ -75,12 +72,11 @@ class CRM_Contact_Form_Task_SaveSearch extends CRM_Contact_Form_Task {
   }
 
   /**
-   * Build the form object - it consists of
+   * Build the form object.
+   *
+   * It consists of
    *    - displaying the QILL (query in local language)
    *    - displaying elements for saving the search
-   *
-   *
-   * @return void
    */
   public function buildQuickForm() {
     // get the qill
@@ -147,9 +143,6 @@ class CRM_Contact_Form_Task_SaveSearch extends CRM_Contact_Form_Task {
 
   /**
    * Process the form after the input has been submitted and validated.
-   *
-   *
-   * @return void
    */
   public function postProcess() {
     // saved search form values
diff --git a/CRM/Contact/Form/Task/SaveSearch/Update.php b/CRM/Contact/Form/Task/SaveSearch/Update.php
index 2d52a15bc0..5b9583eb12 100644
--- a/CRM/Contact/Form/Task/SaveSearch/Update.php
+++ b/CRM/Contact/Form/Task/SaveSearch/Update.php
@@ -29,20 +29,15 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 
 /**
- * This class provides the functionality to update a saved search
- *
+ * This class provides the functionality to update a saved search.
  */
 class CRM_Contact_Form_Task_SaveSearch_Update extends CRM_Contact_Form_Task_SaveSearch {
 
   /**
    * Build all the data structures needed to build the form.
-   *
-   * @return void
    */
   public function preProcess() {
     parent::preProcess();
@@ -59,10 +54,6 @@ class CRM_Contact_Form_Task_SaveSearch_Update extends CRM_Contact_Form_Task_Save
 
   /**
    * Set default values for the form.
-   * the default values are retrieved from the database
-   *
-   *
-   * @return void
    */
   public function setDefaultValues() {
 
diff --git a/CRM/Contact/Form/Task/Unhold.php b/CRM/Contact/Form/Task/Unhold.php
index 61ee1fed84..e9ee12d711 100644
--- a/CRM/Contact/Form/Task/Unhold.php
+++ b/CRM/Contact/Form/Task/Unhold.php
@@ -7,8 +7,6 @@ class CRM_Contact_Form_Task_Unhold extends CRM_Contact_Form_Task {
 
   /**
    * Set variables up before form is built.
-   *
-   * @return void
    */
   public function preProcess() {
     parent::preProcess();
diff --git a/CRM/Contact/Form/Task/Useradd.php b/CRM/Contact/Form/Task/Useradd.php
index 837b8c72fb..60e71357f7 100755
--- a/CRM/Contact/Form/Task/Useradd.php
+++ b/CRM/Contact/Form/Task/Useradd.php
@@ -26,8 +26,7 @@
  */
 
 /**
- * This class generates form components generic to useradd
- *
+ * This class generates form components generic to useradd.
  */
 class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form {
 
@@ -64,11 +63,7 @@ class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form {
   }
 
   /**
-   * Set default values for the form. Note that in edit/view mode
-   * the default values are retrieved from the database
-   *
-   *
-   * @return void
+   * Set default values for the form.
    */
   public function setDefaultValues() {
     $defaults = array();
@@ -83,8 +78,6 @@ class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form {
 
   /**
    * Build the form object.
-   *
-   * @return void
    */
   public function buildQuickForm() {
     $element = $this->add('text', 'name', ts('Full Name'), array('class' => 'huge'));
@@ -118,8 +111,7 @@ class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form {
   }
 
   /**
-   *
-   * @return void
+   * Post process function.
    */
   public function postProcess() {
     // store the submitted values in an array
@@ -131,7 +123,6 @@ class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form {
 
   /**
    * Validation Rule.
-   *
    */
   public static function usernameRule($params) {
     $config = CRM_Core_Config::singleton();
diff --git a/CRM/Contact/Import/Controller.php b/CRM/Contact/Import/Controller.php
index 6f78b677d9..d2a661f21f 100644
--- a/CRM/Contact/Import/Controller.php
+++ b/CRM/Contact/Import/Controller.php
@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 class CRM_Contact_Import_Controller extends CRM_Core_Controller {
 
diff --git a/CRM/Contact/Import/Form/DataSource.php b/CRM/Contact/Import/Form/DataSource.php
index ca38d0a47e..65c8cab55f 100644
--- a/CRM/Contact/Import/Form/DataSource.php
+++ b/CRM/Contact/Import/Form/DataSource.php
@@ -29,13 +29,10 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 
 /**
- * This class delegates to the chosen DataSource to grab the data to be
- *  imported.
+ * This class delegates to the chosen DataSource to grab the data to be imported.
  */
 class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form {
 
@@ -49,8 +46,6 @@ class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form {
 
   /**
    * Set variables up before form is built.
-   *
-   * @return void
    */
   public function preProcess() {
 
@@ -128,8 +123,6 @@ class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form {
 
   /**
    * Build the form object.
-   *
-   * @return void
    */
   public function buildQuickForm() {
 
@@ -295,10 +288,7 @@ class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form {
   }
 
   /**
-   * Call the DataSource's postProcess method to take over
-   * and then setup some common data structures for the next step
-   *
-   * @return void
+   * Call the DataSource's postProcess method.
    */
   public function postProcess() {
     $this->controller->resetPage('MapField');
diff --git a/CRM/Contact/Import/Form/MapField.php b/CRM/Contact/Import/Form/MapField.php
index 88b7c535a5..2b14e69d42 100644
--- a/CRM/Contact/Import/Form/MapField.php
+++ b/CRM/Contact/Import/Form/MapField.php
@@ -29,12 +29,10 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 
 /**
- * This class gets the name of the file to upload
+ * This class gets the name of the file to upload.
  */
 class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField {
 
@@ -92,8 +90,6 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField {
 
   /**
    * Set variables up before form is built.
-   *
-   * @return void
    */
   public function preProcess() {
     $dataSource = $this->get('dataSource');
@@ -200,8 +196,6 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField {
 
   /**
    * Build the form object.
-   *
-   * @return void
    */
   public function buildQuickForm() {
     //to save the current mappings
@@ -660,10 +654,7 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField {
   }
 
   /**
-   * Process the mapped fields and map it into the uploaded file
-   * preview the file and extract some summary statistics
-   *
-   * @return void
+   * Process the mapped fields and map it into the uploaded file.
    */
   public function postProcess() {
     $params = $this->controller->exportValues('MapField');
@@ -984,11 +975,12 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField {
 
   /**
    * Format custom field name.
-   * combine group and field name to avoid conflict.
    *
-   * @param $fields
+   * Combine group and field name to avoid conflict.
    *
-   * @return void
+   * @param array $fields
+   *
+   * @return array
    */
   public function formatCustomFieldName(&$fields) {
     //CRM-2676, replacing the conflict for same custom field name from different custom group.
diff --git a/CRM/Contact/Import/Form/Preview.php b/CRM/Contact/Import/Form/Preview.php
index 5337e678e8..714f8c33f2 100644
--- a/CRM/Contact/Import/Form/Preview.php
+++ b/CRM/Contact/Import/Form/Preview.php
@@ -29,20 +29,15 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 
 /**
- * This class previews the uploaded file and returns summary
- * statistics
+ * This class previews the uploaded file and returns summary statistics.
  */
 class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview {
 
   /**
    * Set variables up before form is built.
-   *
-   * @return void
    */
   public function preProcess() {
     //get the data from the session
@@ -137,8 +132,6 @@ class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview {
 
   /**
    * Build the form object.
-   *
-   * @return void
    */
   public function buildQuickForm() {
     $this->addElement('text', 'newGroupName', ts('Name for new group'));
@@ -250,10 +243,7 @@ class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview {
   }
 
   /**
-   * Process the mapped fields and map it into the uploaded file
-   * preview the file and extract some summary statistics
-   *
-   * @return void
+   * Process the mapped fields and map it into the uploaded file.
    */
   public function postProcess() {
 
@@ -343,10 +333,7 @@ class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview {
   }
 
   /**
-   * Process the mapped fields and map it into the uploaded file
-   * preview the file and extract some summary statistics
-   *
-   * @return void
+   * Process the mapped fields and map it into the uploaded file.
    */
   public function postProcessOld() {
 
diff --git a/CRM/Contact/Import/Form/Summary.php b/CRM/Contact/Import/Form/Summary.php
index 565b536d6d..c326ac76cd 100644
--- a/CRM/Contact/Import/Form/Summary.php
+++ b/CRM/Contact/Import/Form/Summary.php
@@ -29,19 +29,15 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 
 /**
- * This class summarizes the import results
+ * This class summarizes the import results.
  */
 class CRM_Contact_Import_Form_Summary extends CRM_Import_Form_Summary {
 
   /**
    * Set variables up before form is built.
-   *
-   * @return void
    */
   public function preProcess() {
     // set the error message path to display
@@ -125,8 +121,6 @@ class CRM_Contact_Import_Form_Summary extends CRM_Import_Form_Summary {
 
   /**
    * Clean up the import table we used.
-   *
-   * @return void
    */
   public function postProcess() {
     $dao = new CRM_Core_DAO();