CRM-16173 - WhitelistSubscriber - Filtering for API requests (entity/action/params)

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

diff --git a/api/v3/Premium.php b/api/v3/Premium.php
index 75d004343f4129013d6bf4a4aaeb225e05b9f5c5..e2c408df8d6f42134ecaef1df26f51dcdbf8e051 100644 (file)
--- a/api/v3/Premium.php
+++ b/api/v3/Premium.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -26,10 +26,13 @@
  */
 
 /**
- * File for the CiviCRM APIv3 premium functions
+ * This api exposes CiviCRM premiums.
+ *
+ * Premiums are used as incentive gifts on contribution pages.
+ * Premiums contain "Products" which has a separate api.
+ * Use chaining to create a premium and related products in one api call.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_premium
  */
 
 /**
@@ -39,7 +42,6 @@
  *
  * @throws API_Exception
  * @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);