Merge remote-tracking branch 'upstream/4.5' into 4.5-master-2015-03-09-21-44-34

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

diff --git a/api/v3/Batch.php b/api/v3/Batch.php
index fe47e357da2a00e9a717cc8f80572009aeb871f0..32bb97b5a2bd2ab28d133828c9a0de855afc32dc 100644 (file)
--- a/api/v3/Batch.php
+++ b/api/v3/Batch.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -24,37 +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 of newly created batch property values.
- * @access public
+ * @return array
  */
 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
- * @param array $params array or parameters determined by getfields
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ *   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
@@ -70,32 +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 of retrieved batch property values.
- * @access public
+ * @return array
+ *   Array of retrieved batch property values.
  */
 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 of deleted values.
- * @access public
+ * @return array
+ *   Array of deleted values.
  */
 function civicrm_api3_batch_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);