tidy up some unused params

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

diff --git a/api/v3/Pledge.php b/api/v3/Pledge.php
index b4bf07fffee4c8a0476931034370f24d15135f16..c5b0e357549321d9380b25fa52f3caaca479b25a 100644 (file)
--- a/api/v3/Pledge.php
+++ b/api/v3/Pledge.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -49,7 +48,8 @@
  *                             pairs for the activity.
  * {@getfields pledge_create}
  *
- * @return array Array containing 'is_error' to denote success or failure and details of the created pledge
+ * @return array
+ *   Array containing 'is_error' to denote success or failure and details of the created pledge
  *
  * @example PledgeCreate.php Standard create example
  *
@@ -68,11 +68,10 @@ function civicrm_api3_pledge_create($params) {
  * @param array $params
  *   Array included 'pledge_id' of pledge to delete.
  *
- * @return boolean        true if success, else false
- * @static void
+ * @return boolean
+ *   true if success, else false
  * {@getfields pledge_delete}
  * @example PledgeDelete.php
- * @access public
  */
 function civicrm_api3_pledge_delete($params) {
   if (CRM_Pledge_BAO_Pledge::deletePledge($params['id'])) {
@@ -95,6 +94,7 @@ function _civicrm_api3_pledge_delete_spec(&$params) {
 
 /**
  * return field specification specific to get requests
+ * @param array $params
  */
 function _civicrm_api3_pledge_get_spec(&$params) {
   $params['next_pay_date'] = array(
@@ -111,6 +111,7 @@ function _civicrm_api3_pledge_get_spec(&$params) {
 
 /**
  * return field specification specific to get requests
+ * @param array $params
  */
 function _civicrm_api3_pledge_create_spec(&$params) {
 
@@ -129,10 +130,10 @@ function _civicrm_api3_pledge_create_spec(&$params) {
  * @param array $params
  *   Input parameters. Use interrogate for possible fields.
  *
- * @return array  array of pledges, if error an array with an error id and error message
+ * @return array
+ *   array of pledges, if error an array with an error id and error message
  * {@getfields pledge_get}
  * @example PledgeGet.php
- * @access public
  */
 function civicrm_api3_pledge_get($params) {
   $mode = CRM_Contact_BAO_Query::MODE_PLEDGE;
@@ -163,12 +164,10 @@ function _civicrm_api3_pledge_get_defaults() {
  *
  * @param array $values
  *   The reformatted properties that we can use internally.
- * @param bool $create
  *
- * @return array|CRM_Error
- * @access public
+ * @return array|CRM_Core_Error
  */
-function _civicrm_api3_pledge_format_params(&$values, $create = FALSE) {
+function _civicrm_api3_pledge_format_params(&$values) {
 
   // probably most of the below can be removed.... just needs a little more review
   if (array_key_exists('original_installment_amount', $values)) {