Update inline documentation of getSoftContribution
authorJon goldberg - Linux laptop <jon@palantetech.coop>
Tue, 30 Apr 2013 17:39:46 +0000 (10:39 -0700)
committerJon goldberg - Linux laptop <jon@palantetech.coop>
Tue, 30 Apr 2013 23:47:44 +0000 (16:47 -0700)
CRM/Contribute/BAO/Contribution.php

index 1d2d7b2cad9e142636b5a02f797f7578110c39ec..ce22a6305a251cee8dfe1e637a7ff551d3a558f3 100644 (file)
@@ -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) {