ravinderk / Give

includes/admin/donors/class-donor-table.php

Doc Comments +1 added lines, -1 removed lines

@@ -258,7 +258,7 @@
 	 * @access public
 	 * @since  1.0
 	 *
-	 * @return mixed string If search is present, false otherwise.
+	 * @return string|false string If search is present, false otherwise.
 	 */
 	public function get_search() {
 		return ! empty( $_GET['s'] ) ? urldecode( trim( $_GET['s'] ) ) : false;

includes/admin/donors/donor-actions.php

Doc Comments +4 added lines, -4 removed lines

@@ -21,7 +21,7 @@ 
  *
  * @since 1.0
  *
- * @return array|bool $output Response messages
+ * @return false|null $output Response messages
  */
 function give_edit_donor( $args ) {
 
@@ -227,7 +227,7 @@ 
  *
  * @since 1.0
  *
- * @return int Whether it was a successful deletion.
+ * @return false|null Whether it was a successful deletion.
  */
 function give_donor_delete( $args ) {
 
@@ -521,7 +521,7 @@ 
  *
  * @since  1.7
  *
- * @return bool|null
+ * @return false|null
  */
 function give_remove_donor_email() {
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {
@@ -565,7 +565,7 @@ 
  *
  * @since  1.7
  *
- * @return bool|null
+ * @return false|null
  */
 function give_set_donor_primary_email() {
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {

includes/forms/functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -155,7 +155,7 @@ 
  *
  * Used to redirect a user back to the donation form if there are errors present.
  *
- * @param array $args
+ * @param string $args
  *
  * @access public
  * @since  1.0
@@ -301,7 +301,7 @@ 
  * @since  1.0
  * @since  1.8.16 Add security check
  *
- * @return bool
+ * @return false|null
  */
 function give_listen_for_failed_payments() {
 
@@ -741,7 +741,7 @@ 
  *
  * @param int $form_id ID number of the form to retrieve the minimum price for
  *
- * @return mixed string|int Minimum price of the form
+ * @return string string|int Minimum price of the form
  */
 function give_get_form_minimum_price( $form_id = 0 ) {
 

includes/payments/class-give-payment.php

Doc Comments +2 added lines, -2 removed lines

@@ -392,7 +392,7 @@ 
 	 *
 	 * @param  int|bool $payment_id A given payment
 	 *
-	 * @return mixed void|false
+	 * @return false|null void|false
 	 */
 	public function __construct( $payment_id = false ) {
 
@@ -1106,7 +1106,7 @@ 
 	 *
 	 * @param  string|bool $note The note to add
 	 *
-	 * @return bool           If the note was specified or not
+	 * @return false|null           If the note was specified or not
 	 */
 	public function add_note( $note = false ) {
 		// Bail if no note specified.

includes/admin/payments/class-payments-table.php

Doc Comments +4 added lines, -4 removed lines

@@ -467,7 +467,7 @@ 
 	/**
 	 * Get donor email html.
 	 *
-	 * @param object $payment Contains all the data of the payment.
+	 * @param Give_Payment $payment Contains all the data of the payment.
 	 *
 	 * @access public
 	 * @since  1.0
@@ -490,7 +490,7 @@ 
 	/**
 	 * Get Row Actions
 	 *
-	 * @param object $payment Payment Data.
+	 * @param Give_Payment $payment Payment Data.
 	 *
 	 * @since 1.6
 	 *
@@ -530,7 +530,7 @@ 
 	/**
 	 *  Get payment status html.
 	 *
-	 * @param object $payment Contains all the data of the payment.
+	 * @param Give_Payment $payment Contains all the data of the payment.
 	 *
 	 * @access public
 	 * @since  1.0
@@ -580,7 +580,7 @@ 
 	/**
 	 * Get donor html.
 	 *
-	 * @param object $payment Contains all the data of the payment.
+	 * @param Give_Payment $payment Contains all the data of the payment.
 	 *
 	 * @access public
 	 * @since  1.0

includes/admin/class-give-settings.php

Doc Comments +5 added lines, -5 removed lines

@@ -72,7 +72,7 @@ 
 	 *
 	 * @param $url
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function give_update_cmb_meta_box_url( $url ) {
 		// Path to Give's CMB
@@ -935,7 +935,7 @@ 
  * @since      1.3.5
  *
  * @param $array
- * @param $position |int|string Expects an array key or 'id' of the settings field to appear after
+ * @param string $position |int|string Expects an array key or 'id' of the settings field to appear after
  * @param $insert   |array a valid array of options to insert
  *
  * @return array
@@ -974,7 +974,7 @@ 
  * @since 1.0
  *
  * @param array $field_arr
- * @param array $saved_values
+ * @param string|boolean $saved_values
  *
  * @return void
  */
@@ -1009,7 +1009,7 @@ 
  * @since  1.0
  *
  * @param  array $field_arr
- * @param  array $saved_value
+ * @param  string|boolean $saved_value
  *
  * @return void
  */
@@ -1163,7 +1163,7 @@ 
  * @params $string text
  * @params $filter array
  *
- * @return text $string
+ * @return string $string
  */
 function give_slug_to_title( $string, $filters = array() ) {
 

includes/payments/functions.php

Doc Comments +4 added lines, -4 removed lines

@@ -567,7 +567,7 @@ 
  *
  * @since 1.0
  *
- * @return int $earnings Earnings
+ * @return double $earnings Earnings
  */
 function give_get_earnings_by_date( $day = null, $month_num, $year = null, $hour = null ) {
 
@@ -864,7 +864,7 @@ 
  *
  * @since 1.0
  *
- * @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 );
@@ -881,7 +881,7 @@ 
  *
  * @since 1.0
  *
- * @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 );
@@ -1188,7 +1188,7 @@ 
  * and give_format_amount() to format the amount correctly in case of formatted amount.
  *
  * @param int|Give_Payment $donation    Donation ID or Donation Object.
- * @param bool|array       $format_args Currency Formatting Arguments.
+ * @param string       $format_args Currency Formatting Arguments.
  *
  * @since 1.0
  * @since 1.8.17 Added filter and internally use functions.