INFRA-132 - Misc

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

diff --git a/api/v3/PriceField.php b/api/v3/PriceField.php
index 1fdbe9800d1582ee11ed12d49e366b4af984f65f..048f71595c0fc7fc83a46e0ebf2c5c4917f92c8a 100644 (file)
--- a/api/v3/PriceField.php
+++ b/api/v3/PriceField.php
@@ -1,8 +1,7 @@
 <?php
-/*
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -24,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 
 /**
@@ -38,13 +37,14 @@
 /**
  * Create or update a price_field
  *
- * @param array $params  Associative array of property
+ * @param array $params
+ *   Associative array of property.
  *                       name/value pairs to insert in new 'price_field'
  * @example PriceFieldCreate.php Std Create example
  *
- * @return array api result array
- * {@getfields price_field_create}
- * @access public
+ * @return array
+ *   api result array
+ *   {@getfields price_field_create}
  */
 function civicrm_api3_price_field_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -54,7 +54,8 @@ function civicrm_api3_price_field_create($params) {
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_price_field_create_spec(&$params) {
   $params['label']['api.required'] = TRUE;
@@ -63,12 +64,13 @@ function _civicrm_api3_price_field_create_spec(&$params) {
 /**
  * Returns array of price_fields  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
- *  as null, all price_fields will be returned (default limit is 25)
+ * @param array $params
+ *   Array of one or more valid property_name=>value pairs. If $params is set.
+ *   as null, all price_fields will be returned (default limit is 25)
  *
- * @return array  Array of matching price_fields
- * {@getfields price_field_get}
- * @access public
+ * @return array
+ *   Array of matching price_fields
+ *   {@getfields price_field_get}
  */
 function civicrm_api3_price_field_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -80,12 +82,13 @@ function civicrm_api3_price_field_get($params) {
  * This method is used to delete any existing price_field. 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
+ * @param array $params
+ *   Array containing id of the group.
+ *   to be deleted
  *
- * @return array  returns flag true if successfull, error message otherwise
- * {@getfields price_field_delete}
- * @access public
+ * @return array
+ *   API result array
+ *   {@getfields price_field_delete}
  */
 function civicrm_api3_price_field_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);