CRM-16701 - worked around issue creating saved search.

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

diff --git a/api/v3/ContributionRecur.php b/api/v3/ContributionRecur.php
index 41e8bbaf06c161a1328322a409d693ba5b9c6a3d..2db4c8dc3c5d00eda3700dc95cc6e191df57f241 100644 (file)
--- a/api/v3/ContributionRecur.php
+++ b/api/v3/ContributionRecur.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,15 +26,13 @@
  */
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM recurring contributions.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_ContributionRecur
- * @copyright CiviCRM LLC (c) 2004-2014
  */
 
 /**
- * Create or update a contribution_recur.
+ * Create or update a ContributionRecur.
  *
  * @param array $params
  *   Array per getfields metadata.
@@ -52,7 +50,7 @@ function civicrm_api3_contribution_recur_create($params) {
  * The metadata is used for setting defaults, documentation & validation.
  *
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_contribution_recur_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
@@ -65,9 +63,7 @@ function _civicrm_api3_contribution_recur_create_spec(&$params) {
  * Returns array of contribution_recurs 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 contribution_recurs will be returned
+ *   Array of properties. If empty, all records will be returned.
  *
  * @return array
  *   API result Array of matching contribution_recurs
@@ -77,7 +73,7 @@ function civicrm_api3_contribution_recur_get($params) {
 }
 
 /**
- * Cancel a recurring contribution of existing contribution_recur.id.
+ * Cancel a recurring contribution of existing ContributionRecur given its id.
  *
  * @param array $params
  *   Array containing id of the recurring contribution.
@@ -91,14 +87,12 @@ function civicrm_api3_contribution_recur_cancel($params) {
 }
 
 /**
- * Delete an existing contribution_recur.
+ * Delete an existing ContributionRecur.
  *
- * This method is used to delete any existing contribution_recur. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete an existing ContributionRecur given its id.
  *
  * @param array $params
- *   Array containing id of the group.
- *                       to be deleted
+ *   [id]
  *
  * @return array
  *   API result array