INFRA-132 - Batch 14 (g)

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

diff --git a/api/v3/ContributionRecur.php b/api/v3/ContributionRecur.php
index 29be2811e5c0cce979c84bb3175ae448f140f2bf..459f0c240422ad7b7a9d0041fa3047b3a457cc4f 100644 (file)
--- a/api/v3/ContributionRecur.php
+++ b/api/v3/ContributionRecur.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -36,13 +36,14 @@
 /**
  * Create or update a contribution_recur
  *
- * @param array $params  Associative array of property
+ * @param array $params
+ *   Associative array of property.
  *                       name/value pairs to insert in new 'contribution_recur'
  * @example ContributionRecurCreate.php Std Create example
  *
- * @return array api result array
+ * @return array
+ *   api result array
  * {@getfields contribution_recur_create}
- * @access public
  */
 function civicrm_api3_contribution_recur_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -52,7 +53,8 @@ function civicrm_api3_contribution_recur_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_contribution_recur_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
@@ -64,13 +66,14 @@ 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  (referance) Array of one or more valid
+ * @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
  *
- * @return array  (referance) Array of matching contribution_recurs
+ * @return array
+ *   API result Array of matching contribution_recurs
  * {@getfields contribution_recur_get}
- * @access public
  */
 function civicrm_api3_contribution_recur_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -79,9 +82,11 @@ function civicrm_api3_contribution_recur_get($params) {
 /**
  * Cancel a recurring contribution of existing contribution_recur.id
  *
- * @param array    $params (reference) array containing id of the recurring contribution
+ * @param array $params
+ *   (reference) array containing id of the recurring contribution.
  *
- * @return boolean  returns true is successfully cancelled
+ * @return boolean
+ *   returns true is successfully cancelled
  */
 
 function civicrm_api3_contribution_recur_cancel($params) {
@@ -95,13 +100,14 @@ function civicrm_api3_contribution_recur_cancel($params) {
  * This method is used to delete any existing contribution_recur. id of the group
  * to be deleted is required field in $params array
  *
- * @param array $params  (reference) array containing id of the group
+ * @param array $params
+ *   Array containing id of the group.
  *                       to be deleted
  *
- * @return array  (referance) returns flag true if successfull, error
+ * @return array
+ *   API result array
  *                message otherwise
  * {@getfields contribution_recur_delete}
- * @access public
  */
 function civicrm_api3_contribution_recur_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);