CRM-15578 - Mailing.create API - Set defaults that match UX

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

diff --git a/api/v3/PriceSet.php b/api/v3/PriceSet.php
index 78e457d40bc7a5e271d95d61e71eba7c82601491..15061c4b92315bb2e8e2e1e88395dd3808491d38 100644 (file)
--- a/api/v3/PriceSet.php
+++ b/api/v3/PriceSet.php
@@ -23,28 +23,23 @@
  | 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.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_PriceSet
- * @copyright CiviCRM LLC (c) 20042012
  */
 
 /**
- * Create or update a price_set
+ * Create or update a price_set.
  *
  * @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 'price_set'
  *
  * @return array
  *   api result array
- *   {@getfields price_set_create}
  */
 function civicrm_api3_price_set_create($params) {
   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -65,18 +60,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.
@@ -84,7 +80,6 @@ function _civicrm_api3_price_set_create_spec(&$params) {
  *
  * @return array
  *   Array of matching price_sets
- *   {@getfields price_set_get}
  */
 function civicrm_api3_price_set_get($params) {
   // hack to make getcount work. - not sure the best approach here
@@ -101,18 +96,16 @@ function civicrm_api3_price_set_get($params) {
 }
 
 /**
- * delete an existing price_set
+ * Delete an existing price_set.
  *
  * This method is used to delete any existing price_set. id of the group
  * to be deleted is required field in $params array
  *
  * @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}
  */
 function civicrm_api3_price_set_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);