WordImpress / Give

includes/admin/donors/donor-actions.php

Doc Comments +3 added lines, -3 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 ) {
 
@@ -434,7 +434,7 @@ 
  *
  * @since  1.7
  *
- * @return bool|null
+ * @return false|null
  */
 function give_remove_donor_email() {
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {
@@ -478,7 +478,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/admin/donors/donor-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -162,7 +162,7 @@
 /**
  * This function is used to delete donor and related donation without redirection.
  *
- * @param int|Give_Donor $donor Donor ID or List of Donor IDs.
+ * @param Give_Donor $donor Donor ID or List of Donor IDs.
  * @param array          $args  List of arguments to handle donor and related donation deletion process.
  *
  * @type bool delete_donation Delete donor linked donations if set to true. Default is false.

includes/admin/tools/data/class-give-tools-delete-import-donors.php

Doc Comments +1 added lines, -1 removed lines

@@ -290,7 +290,7 @@
 	 *
 	 * @since 1.8.12
 	 *
-	 * @return int
+	 * @return double
 	 */
 	public function get_percentage_complete() {
 		return ceil( ( 100 * $this->step_completed ) / $this->total_step );

includes/class-give-comment.php

Doc Comments +2 added lines, -1 removed lines

@@ -445,7 +445,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 ) ) {
@@ -468,6 +468,7 @@ 
 	 * @access public
 	 *
 	 * @param array @comment_types
+	 * @param string[] $comment_types
 	 *
 	 * @return array
 	 */

includes/class-give-db-meta.php

Doc Comments +2 added lines, -2 removed lines

@@ -279,7 +279,7 @@ 
 	/**
 	 * Rename query clauses for new meta table
 	 *
-	 * @param $clause
+	 * @param string $clause
 	 * @param $filter
 	 *
 	 * @return mixed
@@ -515,7 +515,7 @@ 
 	 * @since  2.0.4
 	 * @access public
 	 *
-	 * @return string
+	 * @return boolean
 	 */
 	public function get_meta_type() {
 		return $this->meta_type;

includes/class-give-donor.php

Doc Comments +1 added lines, -1 removed lines

@@ -1052,7 +1052,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/frontend-donor-functions.php

Doc Comments +1 added lines, -1 removed lines

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

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|string $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() {
 
@@ -1292,7 +1292,7 @@ 
  * @since 2.2.0
  *
  * @param array|integer   $price_or_level_id Price level data.
- * @param boolean|integer $form_id           Donation Form ID.
+ * @param integer $form_id           Donation Form ID.
  *
  * @return boolean
  */

includes/misc-functions.php

Doc Comments +7 added lines, -7 removed lines

@@ -228,7 +228,7 @@ 
  *
  * @since 1.8.17
  *
- * @return array|string
+ * @return boolean
  */
 function give_get_history_session() {
 	return (bool) Give()->session->get( 'history_access' );
@@ -705,7 +705,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() {
 
@@ -983,7 +983,7 @@ 
  *
  * @since 1.8
  *
- * @param $form_id
+ * @param integer $form_id
  *
  * @return bool
  */
@@ -1090,7 +1090,7 @@ 
  * @param int    $id
  * @param string $meta_key
  * @param mixed  $meta_value
- * @param mixed  $prev_value
+ * @param string  $prev_value
  *
  * @return mixed
  */
@@ -1349,7 +1349,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.
  *
@@ -1779,7 +1779,7 @@ 
  *
  * @since 2.1
  *
- * @param $form_id
+ * @param integer $form_id
  *
  * @return bool
  */
@@ -2167,7 +2167,7 @@ 
  *
  * @since 2.2.0
  *
- * @return object
+ * @return Give_Donor
  */
 function give_get_name_with_title_prefixes( $donor ) {