INFRA-132 - Docblock @param and @return tag fixes

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

diff --git a/api/v3/PriceFieldValue.php b/api/v3/PriceFieldValue.php
index 71d749622499996c0853ba8ce54e3d44cde1dcb6..f52967e1b31693912fb69e0864b35d8e5c73314f 100644 (file)
--- a/api/v3/PriceFieldValue.php
+++ b/api/v3/PriceFieldValue.php
@@ -2,7 +2,7 @@
 /*
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -38,17 +38,19 @@
 /**
  * Create or update a price_field_value
  *
- * @param array $params  Associative array of property
+ * @param array $params
+ *   Associative array of property.
  *                       name/value pairs to insert in new 'price_field_value'
  * @example PriceFieldValueCreate.php Std Create example
  *
- * @return array api result array
+ * @return array
+ *   api result array
  * {@getfields price_field_value_create}
  * @access public
  */
 function civicrm_api3_price_field_value_create($params) {
   $ids = array();
-  if(!empty($params['id'])){
+  if (!empty($params['id'])) {
     $ids['id'] = $params['id'];
   }
 
@@ -64,7 +66,8 @@ function civicrm_api3_price_field_value_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_value_create_spec(&$params) {
   $params['price_field_id']['api.required'] = TRUE;
@@ -76,10 +79,12 @@ function _civicrm_api3_price_field_value_create_spec(&$params) {
 /**
  * Returns array of price_field_values  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
+ * @param array $params
+ *   Array of one or more valid property_name=>value pairs. If $params is set.
  *  as null, all price_field_values will be returned (default limit is 25)
  *
- * @return array  Array of matching price_field_values
+ * @return array
+ *   Array of matching price_field_values
  * {@getfields price_field_value_get}
  * @access public
  */
@@ -93,10 +98,12 @@ function civicrm_api3_price_field_value_get($params) {
  * This method is used to delete any existing price_field_value. id of the group
  * to be deleted is required field in $params array
  *
- * @param array $params array containing id of the group
+ * @param array $params
+ *   Array containing id of the group.
  *  to be deleted
  *
- * @return array API result array
+ * @return array
+ *   API result array
  * {@getfields price_field_value_delete}
  * @access public
  */