INFRA-132 - api - Convert single-line @param to multi-line
[civicrm-core.git] / api / v3 / MembershipPayment.php
index 66223572b309ab3c1e294ea989eacf42376760bf..8111ade36be5bc265fa609e6f7c29dffba3ec991 100644 (file)
@@ -2,9 +2,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.                                    |
  |                                                                    |
  * @package CiviCRM_APIv3
  * @subpackage API_Membership
  * @todo delete function doesn't exist
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: MembershipContributionLink.php 30171 2010-10-14 09:11:27Z mover $
  */
 
 /**
  * Add or update a link between contribution and membership
  *
- * @param  array   $params           (reference ) input parameters
+ * @param array $params
+ *   (reference ) input parameters.
  *
  * @return array (reference )        membership_payment_id of created or updated record
  * {@getfields MembershipPayment_create}
@@ -54,7 +55,8 @@ function civicrm_api3_membership_payment_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_membership_payment_create_spec(&$params) {
   $params['membership_id']['api.required'] = 1;
@@ -65,7 +67,8 @@ function _civicrm_api3_membership_payment_create_spec(&$params) {
  * Retrieve one / all contribution(s) / membership(s) linked to a
  * membership / contrbution.
  *
- * @param  array   $params  input parameters
+ * @param array $params
+ *   Input parameters.
  *
  * @return array  array of properties, if error an array with an error id and error message
  *  @example MembershipPaymentGet