ravinderk / Give

includes/class-give-db-donors.php

Doc Comments +4 added lines, -4 removed lines

@@ -165,7 +165,7 @@ 
 	 * NOTE: This should not be called directly as it does not make necessary changes to
 	 * the payment meta and logs. Use give_donor_delete() instead.
 	 *
-	 * @param  bool|string|int $_id_or_email ID or Email of Donor.
+	 * @param  integer $_id_or_email ID or Email of Donor.
 	 *
 	 * @since  1.0
 	 * @access public
@@ -367,7 +367,7 @@ 
 	 * @since  1.4.3
 	 * @access public
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public function update_donor_email_on_user_update( $user_id = 0, $old_user_data = false ) {
 
@@ -424,7 +424,7 @@ 
 	 * @access public
 	 *
 	 * @param  string $field ID or email. Default is 'id'.
-	 * @param  mixed  $value The Customer ID or email to search. Default is 0.
+	 * @param  integer  $value The Customer ID or email to search. Default is 0.
 	 *
 	 * @return mixed         Upon success, an object of the donor. Upon failure, NULL
 	 */
@@ -667,7 +667,7 @@ 
 	 * @access public
 	 * @since  2.0
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public function update_donor_info_on_user_update( $user_id = 0 ) {
 

includes/forms/template.php

Doc Comments +5 added lines, -5 removed lines

@@ -21,7 +21,7 @@ 
  *
  * @since 1.0
  *
- * @return string Donation form.
+ * @return false|null Donation form.
  */
 function give_get_donation_form( $args = array() ) {
 
@@ -1538,7 +1538,7 @@ 
  *
  * @param  int $form_id The form ID.
  *
- * @return bool
+ * @return false|null
  */
 function give_terms_agreement( $form_id ) {
 	$form_option = give_get_meta( $form_id, '_give_terms_option', true );
@@ -1716,7 +1716,7 @@ 
  * @param  int   $form_id The form ID.
  * @param  array $args    An array of form arguments.
  *
- * @return mixed
+ * @return boolean
  */
 function give_show_goal_progress( $form_id, $args ) {
 
@@ -1736,7 +1736,7 @@ 
  *
  * @since  1.8
  *
- * @param  $form_id
+ * @param  integer $form_id
  * @param  $args
  *
  * @return mixed|string
@@ -1777,7 +1777,7 @@ 
  * @param  int   $form_id The form ID.
  * @param  array $args    An array of form arguments.
  *
- * @return void|bool
+ * @return false|null
  */
 function give_form_content( $form_id, $args ) {
 

includes/misc-functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -854,7 +854,7 @@ 
  *
  * @todo Remove this, when WordPress Core ticket is resolved (https://core.trac.wordpress.org/ticket/16828).
  *
- * @return bool
+ * @return false|null
  */
 function give_donation_metabox_menu() {
 
@@ -1525,7 +1525,7 @@ 
  * @since 1.8.13
  *
  * @param array $list List of objects or arrays
- * @param int|string $field Field from the object to place instead of the entire object
+ * @param string $field Field from the object to place instead of the entire object
  * @param int|string $index_key Optional. Field from the object to use as keys for the new array.
  *                              Default null.
  *

includes/payments/functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -692,7 +692,7 @@ 
  * @param  int $year Year number. Default is null.
  * @param  int $hour Hour number. Default is null.
  *
- * @return int $earnings  Earnings
+ * @return double $earnings  Earnings
  */
 function give_get_earnings_by_date( $day = null, $month_num, $year = null, $hour = null ) {
 	// This is getting deprecated soon. Use Give_Payment_Stats with the get_earnings() method instead.
@@ -952,7 +952,7 @@ 
  * @param string $meta_key The meta key to pull.
  * @param bool $single Pull single meta entry or as an object.
  *
- * @return mixed $meta Payment Meta.
+ * @return string $meta Payment Meta.
  */
 function give_get_payment_meta( $payment_id = 0, $meta_key = '_give_payment_meta', $single = true ) {
 	$payment = new Give_Payment( $payment_id );
@@ -1000,7 +1000,7 @@ 
  *
  * @param int $payment_id Payment ID.
  *
- * @return int $form_id Form ID.
+ * @return string $form_id Form ID.
  */
 function give_get_payment_form_id( $payment_id ) {
 	$payment = new Give_Payment( $payment_id );