Merge branch 4.5 into master
[civicrm-core.git] / api / v3 / PledgePayment.php
index e6c83db083f6f16242b6d5ebc3a70d8c2e6a09ae..7e39ff987cc56efb06bd232e45949887b237e5a7 100644 (file)
  */
 
 /**
- * File for the CiviCRM APIv3 Pledge functions
+ * This api exposes CiviCRM Pledge payment.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Pledge_Payment
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: PledgePayment.php
  */
 
 /**
  * Add or update a pledge payment.
  *
- * Pledge Payment API doesn't actually add a pledge
- *  if the request is to 'create' and 'id' is not passed in
- * the oldest pledge with no associated contribution is updated
+ * Pledge Payment API doesn't actually add a pledge.
+ * If the request is to 'create' and 'id' is not passed in
+ * the oldest pledge with no associated contribution is updated.
  *
  * @todo possibly add ability to add payment if there are less payments than pledge installments
  * @todo possibly add ability to recalculate dates if the schedule is changed
@@ -83,7 +79,7 @@ function civicrm_api3_pledge_payment_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_pledge_payment_create_spec(&$params) {
   $params['pledge_id']['api.required'] = 1;