Merge pull request #8088 from JKingsnorth/CRM-18345

[civicrm-core.git] / CRM / Import / DataSource.php

diff --git a/CRM/Import/DataSource.php b/CRM/Import/DataSource.php
index b58e6ad8485d38b2d37b29eb67ec9e94686c1080..3e33ee8c7c4ad185cb2decf8d04efdbc6bb48c40 100644 (file)
--- a/CRM/Import/DataSource.php
+++ b/CRM/Import/DataSource.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2015                                |
+ | Copyright CiviCRM LLC (c) 2004-2016                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2015
+ * @copyright CiviCRM LLC (c) 2004-2016
  * $Id$
  *
  */
@@ -49,23 +49,26 @@ abstract class CRM_Import_DataSource {
 
   /**
    * Set variables up before form is built.
+   *
+   * @param CRM_Core_Form $form
    */
   abstract public function preProcess(&$form);
 
   /**
-   * 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
-   * uploaded to the temporary table in the DB.
+   * This is function is called by the form object to get the DataSource's form snippet.
    *
-   * @param CRM_Core_Form $form
+   * It should add all fields necessary to get the data uploaded to the temporary table in the DB.
    *
-   * @return void
-   *   (operates directly on form argument)
+   * @param CRM_Core_Form $form
    */
   abstract public function buildQuickForm(&$form);
 
   /**
    * Process the form submission.
+   *
+   * @param array $params
+   * @param string $db
+   * @param CRM_Core_Form $form
    */
   abstract public function postProcess(&$params, &$db, &$form);