Merge pull request #6251 from LevityNL/master
[civicrm-core.git] / api / v3 / ParticipantPayment.php
index 1720dfb13282344e2ce0e9fb95ba30af903c5905..0502dff37d011a1b64c198b095a4fa46352a11d7 100644 (file)
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  */
 
 /**
- * File for the CiviCRM APIv3 participant functions
+ * This api exposes CiviCRM participant payments.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Participant
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Participant.php 30486 2010-11-02 16:12:09Z shot $
  */
 
 /**
  * Create a Event Participant Payment.
  *
  * This API is used for creating a Participant Payment of Event.
- * Required parameters : participant_id, contribution_id.
+ * Required parameters: participant_id, contribution_id.
  *
  * @param array $params
  *   An associative array of name/value property values of civicrm_participant_payment.
  *
  * @return array
- *   Array of newly created payment property values.
  */
 function civicrm_api3_participant_payment_create($params) {
 
@@ -67,7 +62,7 @@ function civicrm_api3_participant_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_participant_payment_create_spec(&$params) {
   $params['participant_id']['api.required'] = 1;