X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FPremium.php;h=e2c408df8d6f42134ecaef1df26f51dcdbf8e051;hb=ace09e1280e28e7a8f9a8657b2c6b88bdb6c0389;hp=52827ccc1e38c555119cbbcc482c7ab3e9a505f1;hpb=b081365f52508bfd1fb0d3d15f3a0d48f5e9df12;p=civicrm-core.git

diff --git a/api/v3/Premium.php b/api/v3/Premium.php
index 52827ccc1e..e2c408df8d 100644
--- 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,7 +26,11 @@
  */
 
 /**
- * This api exposes CiviCRM premium.
+ * 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
  */
@@ -38,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);