CRM-16523 towards fixing test issues on this

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

diff --git a/api/v3/PriceSet.php b/api/v3/PriceSet.php
index 6a9d356b6fe2e05ac0ab357a99c50f04377242dc..2c2345edde24fd1886a902fb63ff19d4ba475cb0 100644 (file)
--- a/api/v3/PriceSet.php
+++ b/api/v3/PriceSet.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.                                    |
  |                                                                    |
@@ -27,19 +27,19 @@
 
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM Price Sets.
+ *
+ * PriceSets contain PriceFields (which have their own api).
+ * Use chaining to create a PriceSet and associated PriceFields in one api call.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_PriceSet
- * @copyright CiviCRM LLC (c) 20042012
  */
 
 /**
- * Create or update a price_set.
+ * Create or update a PriceSet.
  *
  * @param array $params
- *   array of property.
- *                       name/value pairs to insert in new 'price_set'
+ *   name/value pairs to insert in new 'PriceSet'
  *
  * @return array
  *   api result array
@@ -68,7 +68,7 @@ function civicrm_api3_price_set_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_price_set_create_spec(&$params) {
   $params['title']['api.required'] = TRUE;
@@ -99,14 +99,12 @@ function civicrm_api3_price_set_get($params) {
 }
 
 /**
- * Delete an existing price_set.
+ * Delete an existing PriceSet.
  *
- * This method is used to delete any existing price_set. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing PriceSet given its id.
  *
  * @param array $params
- *   Array containing id of the group.
- *   to be deleted
+ *   Array containing id of the group to be deleted.
  *
  * @return array
  *   API result array