WordImpress / Give

includes/admin/admin-actions.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
  *
  * @since 1.8
  *
- * @return bool
+ * @return false|null
  */
 function give_redirect_to_clean_url_admin_pages() {
 	// Give admin pages.

includes/admin/tools/class-settings-import.php

Doc Comments +6 added lines

@@ -388,6 +388,9 @@ 
 			}
 		}
 
+		/**
+		 * @param boolean $value
+		 */
 		static function selected( $option_value, $value ) {
 			$selected = '';
 			if ( stristr( $value, $option_value ) ) {
@@ -456,6 +459,9 @@ 
 			<?php
 		}
 
+		/**
+		 * @param integer $file_id
+		 */
 		static function get_csv_total( $file_id ) {
 			$total = false;
 			if ( $file_id ) {

includes/class-give-db-donors.php

Doc Comments +3 added lines, -3 removed lines

@@ -164,7 +164,7 @@ 
 	 * @since  1.0
 	 * @access public
 	 *
-	 * @param  bool|string|int $_id_or_email
+	 * @param  integer $_id_or_email
 	 *
 	 * @return bool|int
 	 */
@@ -359,7 +359,7 @@ 
 	 * @param  int $user_id User ID.
 	 * @param  WP_User|bool $old_user_data User data.
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public function update_donor_email_on_user_update( $user_id = 0, $old_user_data = false ) {
 
@@ -416,7 +416,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
 	 */

includes/class-give-donor.php

Doc Comments +1 added lines, -1 removed lines

@@ -918,7 +918,7 @@
 	 * @access public
 	 *
 	 * @param  string $meta_key Metadata name. Default is empty.
-	 * @param  mixed $meta_value Optional. Metadata value. Default is empty.
+	 * @param  string $meta_value Optional. Metadata value. Default is empty.
 	 *
 	 * @return bool               False for failure. True for success.
 	 */

includes/misc-functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -1481,6 +1481,7 @@ 
  * Check if Import donation is duplicate
  *
  * @since 1.8.13
+ * @param Give_Donate_Form $form
  */
 function give_check_import_donation_duplicate( $payment_data, $data, $form, $donor_data ) {
 	$return = false;
@@ -1566,7 +1567,6 @@ 
  * Import CSV in DB
  *
  * @param int $file_id CSV id
- * @param array $mapto Map csv to meta key.
  * @param int $start Start from which csv line.
  * @param int $end End from which csv line.
  */
@@ -2055,7 +2055,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

@@ -697,7 +697,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 ) {
 
@@ -986,7 +986,7 @@ 
  *
  * @param int $payment_id Payment ID.
  *
- * @return array $user_info User Info Meta Values.
+ * @return string $user_info User Info Meta Values.
  */
 function give_get_payment_meta_user_info( $payment_id ) {
 	$payment = new Give_Payment( $payment_id );
@@ -1003,7 +1003,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 );

includes/user-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -671,7 +671,7 @@
 /**
  * This function will check whether the donor email is primary or additional.
  *
- * @param $email Donor Email.
+ * @param string $email Donor Email.
  *
  * @since 1.8.13
  *