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 887f7ad833220bddf5123a43e79d927cb5533487..2c2345edde24fd1886a902fb63ff19d4ba475cb0 100644 (file)
--- a/api/v3/PriceSet.php
+++ b/api/v3/PriceSet.php
@@ -1,10 +1,9 @@
 <?php
-/*
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -24,29 +23,26 @@
  | 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 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
- *   Associative array of property.
- *                       name/value pairs to insert in new 'price_set'
- * @example PriceSetCreate.php Std Create example
+ *   name/value pairs to insert in new 'PriceSet'
  *
  * @return array
  *   api result array
- * {@getfields price_set_create}
- * @access public
  */
 function civicrm_api3_price_set_create($params) {
   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -67,18 +63,19 @@ function civicrm_api3_price_set_create($params) {
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * 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;
 }
 
 /**
- * Returns array of price_sets  matching a set of one or more group properties
+ * Returns array of price_sets matching a set of one or more group properties.
  *
  * @param array $params
  *   Array of one or more valid property_name=>value pairs. If $params is set.
@@ -86,8 +83,6 @@ function _civicrm_api3_price_set_create_spec(&$params) {
  *
  * @return array
  *   Array of matching price_sets
- * {@getfields price_set_get}
- * @access public
  */
 function civicrm_api3_price_set_get($params) {
   // hack to make getcount work. - not sure the best approach here
@@ -104,19 +99,15 @@ 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
- * {@getfields price_set_delete}
- * @access public
  */
 function civicrm_api3_price_set_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);