ravinderk / Give

includes/admin/donors/donor-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
  * Connect and Reconnect Donor with User profile.
  * @todo  $address is unnecessary param because we are store address to user.
  *
- * @param object $donor      Donor Object.
+ * @param Give_Donor $donor      Donor Object.
  * @param array  $donor_data Donor Post Variables.
  * @param array  $address    Address Information.
  *

includes/class-give-comment.php

Doc Comments +2 added lines, -1 removed lines

@@ -421,7 +421,7 @@ 
 	 * @param int $comment_id
 	 * @param WP_Comment $comment
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function __get_comment_author( $author, $comment_id, $comment ) {
 		if( in_array( $comment->comment_type, $this->comment_types ) ){
@@ -444,6 +444,7 @@ 
 	 * @access public
 	 *
 	 * @param array @comment_types
+	 * @param string[] $comment_types
 	 *
 	 * @return array
 	 */

includes/class-give-donor-wall.php

Doc Comments +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
 	 * @type bool   $show_goal           Whether to display form goal. Default 'true'.
 	 * @type string $avatar_size         Avatar image size in pixels without the "px". Default "
 	 * }
-	 * @return string|bool The markup of the form grid or false.
+	 * @return string|null The markup of the form grid or false.
 	 */
 	public function donor_grid_shortcode( $atts ) {
 

includes/class-give-donor.php

Doc Comments +1 added lines, -1 removed lines

@@ -999,7 +999,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/donors/actions.php

Doc Comments +1 added lines, -1 removed lines

@@ -7,7 +7,7 @@
  * @param int   $donation_id
  * @param array $donation_data
  *
- * @return bool
+ * @return false|null
  */
 function __give_insert_donor_donation_comment( $donation_id, $donation_data ) {
 	if ( empty( $_POST['give_comment'] ) ) {

includes/donors/frontend-donor-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
  *
  * @since 2.1
  *
- * @param string|int $id_or_email
+ * @param string $id_or_email
  *
  * @return bool
  */

includes/payments/functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -564,7 +564,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 ) {
 	// This is getting deprecated soon. Use Give_Payment_Stats with the get_earnings() method instead.
@@ -880,7 +880,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 );
@@ -1385,7 +1385,7 @@ 
  *
  * Retrieves the form title and appends the level name if present.
  *
- * @param int|Give_Payment $donation Donation Data Object.
+ * @param Give_Payment $donation Donation Data Object.
  * @param array            $args     a. only_level = If set to true will only return the level name if multi-level
  *                                   enabled. b. separator  = The separator between the Form Title and the Donation
  *                                   Level.

includes/shortcodes.php

Doc Comments +1 added lines, -1 removed lines

@@ -708,7 +708,7 @@
  * @type string $display_style       How the form is displayed, either in new page or modal popup.
  *                                       Default 'redirect'. Accepts 'redirect', 'modal'.
  * }
- * @return string|bool The markup of the form grid or false.
+ * @return string|null The markup of the form grid or false.
  */
 function give_form_grid_shortcode( $atts ) {