fix comment blocks

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

diff --git a/api/v3/Premium.php b/api/v3/Premium.php
index 957d5361a3207ce6b0d8b15744152b1e0b9911af..87bfe6fff9c02735b851f8ccbccf1294e2045273 100644 (file)
--- a/api/v3/Premium.php
+++ b/api/v3/Premium.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -41,11 +40,11 @@
  * {@getfields premium_create}
  * @example premiumCreate.php
  *
- * @param $params
+ * @param array $params
  *
  * @throws API_Exception
- * @return array of newly created premium property values.
- * @access public
+ * @return array
+ *   Array of newly created premium property values.
  */
 function civicrm_api3_premium_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -58,10 +57,10 @@ function civicrm_api3_premium_create($params) {
  * {@getfields premium_get}
  * @example premiumCreate.php
  *
- * @param $params
+ * @param array $params
  *
- * @return array of retrieved premium property values.
- * @access public
+ * @return array
+ *   Array of retrieved premium property values.
  */
 function civicrm_api3_premium_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -74,11 +73,11 @@ function civicrm_api3_premium_get($params) {
  * {@getfields premium_delete}
  * @example premiumCreate.php
  *
- * @param $params
+ * @param array $params
  *
  * @throws API_Exception
- * @return array of deleted values.
- * @access public
+ * @return array
+ *   Array of deleted values.
  */
 function civicrm_api3_premium_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -86,6 +85,7 @@ function civicrm_api3_premium_delete($params) {
 
 /**
  * return field specification specific to get requests
+ * @param array $params
  */
 function _civicrm_api3_premium_get_spec(&$params) {
   $params['premiums_active']['api.aliases'] = array('is_active');
@@ -93,6 +93,7 @@ function _civicrm_api3_premium_get_spec(&$params) {
 
 /**
  * return field specification specific to create requests
+ * @param array $params
  */
 function _civicrm_api3_premium_create_spec(&$params) {
   $params['premiums_active']['api.aliases'] = array('is_active');