ravinderk / Give

includes/class-give-comment.php

Doc Comments +2 added lines, -1 removed lines

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

includes/forms/template.php

Doc Comments +7 added lines, -8 removed lines

@@ -21,7 +21,7 @@ 
  *
  * @since 1.0
  *
- * @return string Donation form.
+ * @return false|null Donation form.
  */
 function give_get_donation_form( $args = array() ) {
 
@@ -1482,7 +1482,7 @@ 
  *
  * @param  int $form_id The form ID.
  *
- * @return bool
+ * @return false|null
  */
 function give_terms_agreement( $form_id ) {
 	$form_option = give_get_meta( $form_id, '_give_terms_option', true );
@@ -1676,7 +1676,7 @@ 
  * @param  int   $form_id The form ID.
  * @param  array $args    An array of form arguments.
  *
- * @return mixed
+ * @return boolean
  */
 function give_show_goal_progress( $form_id, $args = array() ) {
 
@@ -1703,7 +1703,7 @@ 
  * @param  int $total      Total amount based on shortcode parameter.
  * @param  int $total_goal Total Goal amount passed by Admin.
  *
- * @return mixed
+ * @return boolean
  */
 function give_show_goal_totals_progress( $total, $total_goal ) {
 
@@ -1727,7 +1727,7 @@ 
  *
  * @since  1.8
  *
- * @param  $form_id
+ * @param  integer $form_id
  * @param  $args
  *
  * @return mixed|string
@@ -1768,7 +1768,7 @@ 
  * @param  int   $form_id The form ID.
  * @param  array $args    An array of form arguments.
  *
- * @return void|bool
+ * @return false|null
  */
 function give_form_content( $form_id, $args ) {
 
@@ -2050,7 +2050,7 @@ 
  *
  * @since 2.1
  *
- * @return array
+ * @return string[]
  */
 function add_class_for_form_grid( $class, $id, $args ) {
 	$class[] = 'give-form-grid-wrap';
@@ -2061,7 +2061,6 @@ 
 /**
  * Add hidden field to Form Grid page
  *
- * @param int              $form_id The form ID.
  * @param array            $args    An array of form arguments.
  * @param Give_Donate_Form $form    Form object.
  *

includes/import-functions.php

Doc Comments +5 added lines, -5 removed lines

@@ -555,10 +555,10 @@ 
  *
  * @since 2.1
  *
- * @param $file_dir
- * @param $start
- * @param $end
- * @param $delimiter
+ * @param false|string $file_dir
+ * @param integer $start
+ * @param integer $end
+ * @param string $delimiter
  *
  * @return array
  */
@@ -584,7 +584,7 @@ 
  *
  * @since 2.1
  *
- * @param $file_id
+ * @param integer $file_id
  *
  * @return false|string file content
  */

includes/payments/class-give-sequential-donation-number.php

Doc Comments +1 added lines, -1 removed lines

@@ -197,7 +197,7 @@
 	 * @since
 	 * @access public
 	 *
-	 * @param $serial_number
+	 * @param integer $serial_number
 	 *
 	 * @return string
 	 */

includes/payments/functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -569,7 +569,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.

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 ) {
 
@@ -431,7 +431,7 @@ 
  *
  * @since  1.7
  *
- * @return bool|null
+ * @return false|null
  */
 function give_remove_donor_email() {
 	if ( empty( $_GET['id'] ) || ! is_numeric( $_GET['id'] ) ) {
@@ -475,7 +475,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-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;