woothemes / sensei

includes/class-sensei-settings.php

Doc Comments +2 added lines, -2 removed lines

@@ -60,8 +60,8 @@
     /**
      * @since 1.9.0
      *
-     * @param $setting
-     * @param $new_value
+     * @param string $setting
+     * @param integer $new_value
      */
     public function set( $setting, $new_value ){
 

includes/class-sensei-grading.php

Doc Comments +9 added lines, -8 removed lines

@@ -21,7 +21,7 @@ 
 	 * Constructor
 	 * @since  1.3.0
      *
-     * @param $file
+     * @param string $file
 	 */
 	public function __construct ( $file ) {
 		$this->name = __( 'Grading', 'woothemes-sensei' );
@@ -328,6 +328,7 @@ 
 	/**
 	 * Return array of valid statuses for either Course or Lesson
 	 * @since  1.7.0
+	 * @param string $type
 	 * @return array
 	 */
 	public function get_stati( $type ) {
@@ -527,7 +528,7 @@ 
      * the grades as the Grader selected theme and saves the total grade and
      * individual question grades.
      *
-     * @return bool
+     * @return false|null
      */
     public function admin_process_grading_submission() {
 
@@ -904,8 +905,8 @@ 
      * Grading logic specifically for the gap fill questions
      *
      * @since 1.9.0
-     * @param $question_id
-     * @param $user_answer
+     * @param integer $question_id
+     * @param string $user_answer
      *
      * @return bool | int false or the grade given to the user answer
      */
@@ -1009,7 +1010,7 @@ 
      * Add together all the graded lesson grades
      *
      * @since 1.9.0
-     * @return double $sum_of_all_grades
+     * @return integer $sum_of_all_grades
      */
     public static function get_graded_lessons_sum(){
 
@@ -1032,7 +1033,7 @@ 
      *
      * @since 1.9.0
      * @param $user_id
-     * @return double
+     * @return integer
      */
     public static function get_user_graded_lessons_sum( $user_id ){
         global $wpdb;
@@ -1055,7 +1056,7 @@ 
      * @since 1.9.0
      *
      * @param int lesson_id
-     * @return double
+     * @return integer
      */
     public static function get_lessons_users_grades_sum( $lesson_id ){
 
@@ -1080,7 +1081,7 @@ 
      * @since 1.9.0
      *
      * @param int $course_id
-     * @return double
+     * @return integer
      */
     public static function get_course_users_grades_sum( $course_id ){
 

includes/class-sensei.php

Doc Comments +3 added lines, -3 removed lines

@@ -816,7 +816,7 @@ 
      *
      * @since 1.4.5
      * @access public
-     * @param mixed $image_size
+     * @param string $image_size
      * @return string
      */
     public function get_image_size( $image_size ) {
@@ -1042,7 +1042,7 @@ 
      * @since  1.0.0
      * @param  int 			$course_id  (default: 0)
      * @param  array/Object $order_user (default: array()) Specific user's data.
-     * @return bool|int
+     * @return boolean|string
      */
     public function woocommerce_course_update ( $course_id = 0, $order_user = array()  ) {
 
@@ -1085,7 +1085,7 @@ 
      * Disable guest checkout if a course product is in the cart
      * @deprecated since 1.9.0
      * @param  boolean $guest_checkout Current guest checkout setting
-     * @return boolean                 Modified guest checkout setting
+     * @return string|boolean                 Modified guest checkout setting
      */
     public function disable_guest_checkout( $guest_checkout ) {
 

includes/class-sensei-wc.php

Doc Comments +8 added lines, -7 removed lines

@@ -836,7 +836,7 @@ 
      * @param  int $user_id
      * @param  int $product_id
      *
-     * @return bool
+     * @return boolean|null
      */
     public static function has_customer_bought_product ( $user_id, $product_id ){
 
@@ -941,7 +941,7 @@ 
      * @since   1.2.0
      * @since  1.9.0 move to class Sensei_WC
      *
-     * @param   WC_Order $order
+     * @param   integer $order
      *
      * @return  void
      */
@@ -1152,6 +1152,7 @@ 
      * @since   1.2.0
      * @since   1.9.0 Move function to the Sensei_WC class
      * @param   integer| WC_Order $order_id order ID
+     * @param integer $order_id
      * @return  void
      */
     public static function cancel_order ( $order_id ) {
@@ -1261,7 +1262,7 @@ 
      * @param  int 			$course_id  (default: 0)
      * @param  array/Object $order_user (default: array()) Specific user's data.
      *
-     * @return bool|int
+     * @return boolean|string
      */
     public static function course_update ( $course_id = 0, $order_user = array()  ) {
 
@@ -1334,7 +1335,7 @@ 
      *
      * @param  boolean $guest_checkout Current guest checkout setting
      *
-     * @return boolean                 Modified guest checkout setting
+     * @return string|boolean                 Modified guest checkout setting
      */
     public static function disable_guest_checkout( $guest_checkout ) {
 
@@ -1508,7 +1509,7 @@ 
      * Get all the valid subscription types.
      *
      * @since 1.9.0
-     * @return array
+     * @return string[]
      */
     public static function get_subscription_types(){
 
@@ -1526,8 +1527,8 @@ 
      *
      * @since 1.9.0
      *
-     * @param $user_id
-     * @param $product_id
+     * @param integer $user_id
+     * @param string $product_id
      * @param $course_id
      *
      * @return bool