Merge pull request #5044 from colemanw/Comment

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

diff --git a/api/v3/Pledge.php b/api/v3/Pledge.php
index 958f38d30513834ade23606ae83d29ab31658104..1e3c340474e693eae4a702e11c23a96f331fa4af 100644 (file)
--- a/api/v3/Pledge.php
+++ b/api/v3/Pledge.php
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * File for the CiviCRM APIv3 Pledge functions
@@ -68,12 +68,10 @@ function civicrm_api3_pledge_create($params) {
  * @param array $params
  *   Array included 'pledge_id' of pledge to delete.
  *
- * @return boolean
+ * @return bool
  *   true if success, else false
- * @static
- * {@getfields pledge_delete}
+ *   {@getfields pledge_delete}
  * @example PledgeDelete.php
- * @access public
  */
 function civicrm_api3_pledge_delete($params) {
   if (CRM_Pledge_BAO_Pledge::deletePledge($params['id'])) {
@@ -96,7 +94,7 @@ function _civicrm_api3_pledge_delete_spec(&$params) {
 
 /**
  * return field specification specific to get requests
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_pledge_get_spec(&$params) {
   $params['next_pay_date'] = array(
@@ -113,7 +111,7 @@ function _civicrm_api3_pledge_get_spec(&$params) {
 
 /**
  * return field specification specific to get requests
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_pledge_create_spec(&$params) {
 
@@ -134,9 +132,8 @@ function _civicrm_api3_pledge_create_spec(&$params) {
  *
  * @return array
  *   array of pledges, if error an array with an error id and error message
- * {@getfields pledge_get}
+ *   {@getfields pledge_get}
  * @example PledgeGet.php
- * @access public
  */
 function civicrm_api3_pledge_get($params) {
   $mode = CRM_Contact_BAO_Query::MODE_PLEDGE;
@@ -167,12 +164,9 @@ 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
  */
-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)) {