Merge pull request #4948 from pratikshad/code-cleanup

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

diff --git a/api/v3/ContributionSoft.php b/api/v3/ContributionSoft.php
index 2089e485cdff0e13b06a8bbf13fbcd99e617a921..5134e94f5b51345d26d10dbe537a88d0b3c18d55 100644 (file)
--- a/api/v3/ContributionSoft.php
+++ b/api/v3/ContributionSoft.php
@@ -3,9 +3,9 @@
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -33,21 +33,22 @@
  * @package CiviCRM_APIv3
  * @subpackage API_ContributionSoft
  *
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: ContributionSoft.php 2013-05-01 Jon Goldberg $
  */
 
 /**
  * Create or Update a Soft Credit
  *
- * @param array $params  Associative array of property
+ * @param array $params
+ *   Associative array of property.
  *                       name/value pairs to insert in new 'contribution_soft'
  *
  * @example ContributionSoftCreate.php Standard Create Example //FIXME
  *
- * @return array API result array
+ * @return array
+ *   API result array
  * {@getfields contribution_soft_create}
- * @access public
  */
 function civicrm_api3_contribution_soft_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -57,7 +58,8 @@ function civicrm_api3_contribution_soft_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_soft_create_spec(&$params) {
   $params['contribution_id']['api.required'] = 1;
@@ -68,13 +70,13 @@ function _civicrm_api3_contribution_soft_create_spec(&$params) {
 /**
  * Deletes an existing Soft Credit
  *
- * @param  array  $params
+ * @param array $params
  *
  * @example ContributionSoftDelete.php Standard Delete Example
  *
- * @return boolean | error  true if successfull, error otherwise
+ * @return boolean
+ *   | error  true if successfull, error otherwise
  * {@getfields contribution_soft_delete}
- * @access public
  */
 function civicrm_api3_contribution_soft_delete($params) {
   // non standard BAO - we have to write custom code to cope
@@ -85,18 +87,18 @@ function civicrm_api3_contribution_soft_delete($params) {
 /**
  * Retrieve one or more Soft Credits
  *
- * @param  array input parameters
+ * @param array input parameters
  *
  *
  * @example ContributionSoftGet.php Standard Get Example
  *
- * @param  array $params  an associative array of name/value pairs.
+ * @param array $params
+ *   An associative array of name/value pairs.
  *
- * @return  array api result
+ * @return array
+ *   api result
  * {@getfields contribution_soft_get}
- * @access public
  */
 function civicrm_api3_contribution_soft_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-