CRM-16701 - worked around issue creating saved search.

[civicrm-core.git] / api / v3 / Batch.php

diff --git a/api/v3/Batch.php b/api/v3/Batch.php
index ae9e2a91dedd8cdcf7aab4c263cc5bfb4b3e9e1f..7df122f7520a033d7ed790cc6908fbfe2a208c9a 100644 (file)
--- a/api/v3/Batch.php
+++ b/api/v3/Batch.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,39 +23,32 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 batch functions
+ * This api exposes CiviCRM Batch records.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Batch
- *
  */
 
 /**
- * Save a Batch
- *
- * Allowed @params array keys are:
- * {@getfields batch_create}
- * @example BatchCreate.php
+ * Save a Batch.
  *
  * @param array $params
  *
  * @return array
- *   Array of newly created batch property values.
- * @access public
  */
 function civicrm_api3_batch_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * 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
@@ -71,34 +64,24 @@ function _civicrm_api3_batch_create_spec(&$params) {
 }
 
 /**
- * Get a Batch
- *
- * Allowed @params array keys are:
- * {@getfields batch_get}
- * @example BatchCreate.php
+ * Get a Batch.
  *
  * @param array $params
  *
  * @return array
  *   Array of retrieved batch property values.
- * @access public
  */
 function civicrm_api3_batch_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Delete a Batch
- *
- * Allowed @params array keys are:
- * {@getfields batch_delete}
- * @example BatchCreate.php
+ * Delete a Batch.
  *
  * @param array $params
  *
  * @return array
  *   Array of deleted values.
- * @access public
  */
 function civicrm_api3_batch_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);