Merge pull request #6450 from civicrm/4.6

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

diff --git a/api/v3/ContributionSoft.php b/api/v3/ContributionSoft.php
index 0bb378bf859ec6de6263915fe1932481c1b338eb..fb795384a032b1958d85f5444e258475cc551adb 100644 (file)
--- a/api/v3/ContributionSoft.php
+++ b/api/v3/ContributionSoft.php
@@ -1,11 +1,9 @@
 <?php
-// $Id$
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -25,39 +23,34 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 soft credit functions
+ * This api exposes CiviCRM soft credits.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_ContributionSoft
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: ContributionSoft.php 2013-05-01 Jon Goldberg $
  */
 
 /**
- * Create or Update a Soft Credit
+ * Create or Update a Soft Credit.
  *
- * @param array $params  Associative array of property
- *                       name/value pairs to insert in new 'contribution_soft'
+ * @param array $params
+ *   Array per getfields metadata.
  *
- * @example ContributionSoftCreate.php Standard Create Example //FIXME
- *
- * @return array API result array
- * {@getfields contribution_soft_create}
- * @access public
+ * @return array
+ *   API result array
  */
 function civicrm_api3_contribution_soft_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_contribution_soft_create_spec(&$params) {
   $params['contribution_id']['api.required'] = 1;
@@ -66,37 +59,25 @@ function _civicrm_api3_contribution_soft_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing Soft Credit
- *
- * @param  array  $params
+ * Deletes an existing Soft Credit.
  *
- * @example ContributionSoftDelete.php Standard Delete Example
- *
- * @return boolean | error  true if successfull, error otherwise
- * {@getfields contribution_soft_delete}
- * @access public
+ * @param array $params
  */
 function civicrm_api3_contribution_soft_delete($params) {
-  // non standard BAO - we have to write custom code to cope
+  // Non standard BAO - we have to write custom code to cope.
   CRM_Contribute_BAO_ContributionSoft::del(array('id' => $params['id']));
 
 }
 
 /**
- * Retrieve one or more Soft Credits
- *
- * @param  array input parameters
- *
+ * Retrieve one or more Soft Credits.
  *
- * @example ContributionSoftGet.php Standard Get Example
+ * @param array $params
+ *   Array per getfields metadata.
  *
- * @param  array $params  an associative array of name/value pairs.
- *
- * @return  array api result
- * {@getfields contribution_soft_get}
- * @access public
+ * @return array
+ *   API result
  */
 function civicrm_api3_contribution_soft_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-