Merge pull request #7150 from colemanw/CRM-13823
[civicrm-core.git] / api / v3 / Batch.php
index d9524ffc51861dd9c9da6fd9b7301f7a16f25a14..f192d16f8630bb2527aa1b893df9505c39421be9 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  */
 
 /**
- * File for the CiviCRM APIv3 batch functions
+ * This api exposes CiviCRM Batch records.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Batch
  */
 
 /**
@@ -38,7 +37,6 @@
  * @param array $params
  *
  * @return array
- *   Array of newly created batch property values.
  */
 function civicrm_api3_batch_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -50,7 +48,7 @@ function civicrm_api3_batch_create($params) {
  * The metadata is used for setting defaults, documentation & validation.
  *
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_batch_create_spec(&$params) {
   //@todo - the entity table field looks like it is not actually required & should probably be removed (or a description added if