ravinderk / Give

includes/admin/class-give-settings.php

Doc Comments +4 added lines, -4 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
@@ -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
  */
@@ -1170,7 +1170,7 @@ 
  *  @params $string text
  *  @params $filter array
  *
- *  @return text $string
+ *  @return string $string
  */
 function give_slug_to_title( $string, $filters = array() ){
 

includes/admin/donors/donor-actions.php

Doc Comments +3 added lines, -3 removed lines

@@ -272,7 +272,7 @@ 
  *
  * @param  array $args The $_POST array being passed.
  *
- * @return int Whether it was a successful deletion.
+ * @return false|null Whether it was a successful deletion.
  */
 function give_donor_delete( $args ) {
 
@@ -546,7 +546,7 @@ 
  * Remove an email address to the donor from within the admin and log a donor note and redirect back to the donor interface for feedback.
  *
  * @since  1.7
- * @return bool|null
+ * @return false|null
  */
 function give_remove_donor_email() {
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {
@@ -589,7 +589,7 @@ 
  * and redirect back to the donor interface for feedback
  *
  * @since  1.7
- * @return bool|null
+ * @return false|null
  */
 function give_set_donor_primary_email() {
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {

includes/api/class-give-api.php

Doc Comments +3 added lines, -3 removed lines

@@ -216,7 +216,7 @@ 
 	 *
 	 * @access public
 	 * @since  1.1
-	 * @return array
+	 * @return string
 	 */
 	public function get_versions() {
 		return $this->versions;
@@ -302,7 +302,7 @@ 
 	 * @uses   Give_API::invalid_key()
 	 * @uses   Give_API::invalid_auth()
 	 * @since  1.1
-	 * @return bool
+	 * @return false|null
 	 */
 	private function validate_request() {
 		global $wp_query;
@@ -694,7 +694,7 @@ 
 	 *
 	 * @param array $args Arguments to override defaults
 	 *
-	 * @return array $dates
+	 * @return integer|null $dates
 	 */
 	public function get_dates( $args = array() ) {
 		$dates = array();

includes/class-give-db-donors.php

Doc Comments +3 added lines, -3 removed lines

@@ -158,7 +158,7 @@ 
 	 * @since  1.0
 	 * @access public
 	 *
-	 * @param  bool|string|int $_id_or_email
+	 * @param  integer $_id_or_email
 	 *
 	 * @return bool|int
 	 */
@@ -313,7 +313,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 ) {
 
@@ -370,7 +370,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/login-register.php

Doc Comments +2 added lines, -2 removed lines

@@ -174,7 +174,7 @@ 
  * @param string $user_login Username
  * @param string $user_pass  Password
  *
- * @return bool
+ * @return false|null
  */
 function give_log_user_in( $user_id, $user_login, $user_pass ) {
 
@@ -215,7 +215,7 @@ 
  *
  * @param array $data Data sent from the register form
  *
- * @return bool
+ * @return false|null
  */
 function give_process_register_form( $data ) {
 

includes/actions.php

Doc Comments -1 removed lines

@@ -217,7 +217,6 @@
 /**
  * Set Donation Amount for Multi Level Donation Forms
  *
- * @param int    $form_id
  * @param object $form
  *
  * @since 1.8.9

includes/payments/functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -684,7 +684,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 ) {
 
@@ -942,7 +942,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 );
@@ -990,7 +990,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 );