CRM-16523 towards fixing test issues on this

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

diff --git a/api/v3/PriceField.php b/api/v3/PriceField.php
index e63a28cb799c2ff2b3dfb78775921db36010c0f6..81237b91e3aa479751bddc74336ae44574b1cceb 100644 (file)
--- a/api/v3/PriceField.php
+++ b/api/v3/PriceField.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.                                    |
  |                                                                    |
@@ -29,6 +29,10 @@
 /**
  * This api exposes CiviCRM price set fields.
  *
+ * PriceSets contain PriceFields, which may contain PriceFieldValues.
+ * Each has its own api.
+ * Use chaining to create a PriceSet and associated PriceFields and values in one api call.
+ *
  * @package CiviCRM_APIv3
  */
 
@@ -74,8 +78,7 @@ function civicrm_api3_price_field_get($params) {
 /**
  * Delete an existing price_field.
  *
- * This method is used to delete any existing price_field. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing price_field given its id.
  *
  * @param array $params
  *   Array containing id of the group to be deleted.