From: Jon goldberg - Linux laptop <jon@palantetech.coop>
Date: Tue, 30 Apr 2013 17:39:46 +0000 (-0700)
Subject: Update inline documentation of getSoftContribution
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=f704db18fa1805228c66f518234caaac983b05ca;p=civicrm-core.git

Update inline documentation of getSoftContribution
---

diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php
index 1d2d7b2cad..ce22a6305a 100644
--- a/CRM/Contribute/BAO/Contribution.php
+++ b/CRM/Contribute/BAO/Contribution.php
@@ -1236,10 +1236,11 @@ LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.cont
   }
 
   /**
-   *  Function to retrieve soft contribution for contribution record.
+   *  Function to retrieve soft contributions for contribution record.
    *  @param array $params an associated array
+   *  @param boolean $all include PCP data
    *
-   *  @return soft contribution id
+   *  @return array of soft contribution ids, amounts, and associated contact ids
    *  @static
    */
   static function getSoftContribution($params, $all = FALSE) {