Merge pull request #9789 from fliespl/patch-2

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

diff --git a/api/v3/PriceField.php b/api/v3/PriceField.php
index fd9d00e1f197119a23334ac9ddc58445b55a63b5..afb073eb9e952797a7b9d5489e4e6a9d68a12b54 100644 (file)
--- a/api/v3/PriceField.php
+++ b/api/v3/PriceField.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2017                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -27,19 +27,20 @@
 
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * 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
- * @subpackage API_PriceField
- * @copyright CiviCRM LLC (c) 20042012
  */
 
 /**
  * Create or update a price_field.
  *
  * @param array $params
- *   Associative array of property.
- *                       name/value pairs to insert in new 'price_field'
+ *   name/value pairs to insert in new 'price_field'
  *
  * @return array
  *   api result array
@@ -54,7 +55,7 @@ function civicrm_api3_price_field_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_field_create_spec(&$params) {
   $params['label']['api.required'] = TRUE;
@@ -77,12 +78,10 @@ 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
+ *   Array containing id of the group to be deleted.
  *
  * @return array
  *   API result array