From 69dbd1ba7a738544159218f1bd05236711a9fa66 Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Sun, 4 May 2014 20:03:45 -0700
Subject: [PATCH] Comment fixes

---
 api/v3/Contribution.php | 22 +++++++++++++++-------
 api/v3/Job.php          |  4 +++-
 api/v3/MailingJob.php   |  4 +++-
 3 files changed, 21 insertions(+), 9 deletions(-)

diff --git a/api/v3/Contribution.php b/api/v3/Contribution.php
index 4394e0628f..c1b9678380 100644
--- a/api/v3/Contribution.php
+++ b/api/v3/Contribution.php
@@ -40,8 +40,9 @@
 /**
  * Add or update a contribution
  *
- * @param  array   $params           (reference ) input parameters
+ * @param  array $params (reference ) input parameters
  *
+ * @throws API_Exception
  * @return array  Api result array
  * @static void
  * @access public
@@ -162,8 +163,9 @@ function _civicrm_api3_contribution_delete_spec(&$params) {
 /**
  * Retrieve a set of contributions, given a set of input params
  *
- * @param  array   $params           (reference ) input parameters
- * @param array    $returnProperties Which properties should be included in the
+ * @param  array $params (reference ) input parameters
+ *
+ * @internal param array $returnProperties Which properties should be included in the
  * returned Contribution object. If NULL, the default
  * set of properties will be included.
  *
@@ -224,11 +226,13 @@ function _civicrm_api3_contribution_get_spec(&$params) {
  * take the input parameter list as specified in the data model and
  * convert it into the same format that we use in QF and BAO object
  *
- * @param array  $params       Associative array of property name/value
+ * @param array $params Associative array of property name/value
  * pairs to insert in new contact.
- * @param array  $values       The reformatted properties that we can use internally
+ * @param array $values The reformatted properties that we can use internally
  * '
  *
+ * @param bool $create
+ *
  * @return array|CRM_Error
  * @access public
  */
@@ -298,16 +302,19 @@ function civicrm_api3_contribution_transact($params) {
 
   return civicrm_api('contribution', 'create', $params);
 }
+
 /**
  * Send a contribution confirmation (receipt or invoice)
  * The appropriate online template will be used (the existence of related objects
  * (e.g. memberships ) will affect this selection
+ *
  * @param array $params input parameters
  * {@getfields Contribution_sendconfirmation}
+ *
+ * @throws Exception
  * @return array  Api result array
  * @static void
  * @access public
- *
  */
 function civicrm_api3_contribution_sendconfirmation($params) {
   $contribution = new CRM_Contribute_BAO_Contribution();
@@ -358,10 +365,11 @@ function _civicrm_api3_contribution_sendconfirmation_spec(&$params) {
  *
  * @param array $params input parameters
  * {@getfields Contribution_completetransaction}
+ *
+ * @throws API_Exception
  * @return array  Api result array
  * @static void
  * @access public
- *
  */
 function civicrm_api3_contribution_completetransaction(&$params) {
 
diff --git a/api/v3/Job.php b/api/v3/Job.php
index a7effd69d2..cb8bbfac73 100644
--- a/api/v3/Job.php
+++ b/api/v3/Job.php
@@ -88,7 +88,9 @@ function civicrm_api3_job_get($params) {
 /**
  * Delete a job
  *
- * @param int $id
+ * @param $params
+ *
+ * @internal param int $id
  *
  * @return array API Result Array
  * {@getfields Job_delete}
diff --git a/api/v3/MailingJob.php b/api/v3/MailingJob.php
index 5357ec22de..82d132e511 100644
--- a/api/v3/MailingJob.php
+++ b/api/v3/MailingJob.php
@@ -63,7 +63,9 @@ function _civicrm_api3_mailing_job_create_spec(&$params) {
 /**
  * Returns array of Mailing Jobs  matching a set of one or more group properties
  *
- * @param array $params  Array of one or more valid
+ * @param array $params Array of one or more valid
+ * @param array $ids
+ *
  * @return array API return Array of matching mailing jobs
  * {@getfields mailing_job_get}
  * @access public
-- 
2.25.1