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 15061c4b92315bb2e8e2e1e88395dd3808491d38..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,16 +27,19 @@
 
 
 /**
- * This api exposes CiviCRM price sets.
+ * 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
  */
 
 /**
- * Create or update a price_set.
+ * Create or update a PriceSet.
  *
  * @param array $params
- *   name/value pairs to insert in new 'price_set'
+ *   name/value pairs to insert in new 'PriceSet'
  *
  * @return array
  *   api result array
@@ -96,10 +99,9 @@ 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.