woothemes / sensei

includes/class-sensei-wc.php

Doc Comments +6 added lines, -5 removed lines

@@ -994,7 +994,7 @@ 
      * @since   1.2.0
      * @since  1.9.0 move to class Sensei_WC
      *
-     * @param   WC_Order $order
+     * @param   integer $order
      *
      * @return  void
      */
@@ -1212,6 +1212,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 ) {
@@ -1402,7 +1403,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 ) {
 
@@ -1639,7 +1640,7 @@ 
      * Get all the valid subscription types.
      *
      * @since 1.9.0
-     * @return array
+     * @return string[]
      */
     public static function get_subscription_types(){
 
@@ -1658,7 +1659,7 @@ 
      * @since 1.9.0
      *
      * @param $user_id
-     * @param $product_id
+     * @param string $product_id
      * @param $course_id
      *
      * @return bool
@@ -1725,7 +1726,7 @@ 
 	 * Get all the orders for a specific user and product combination
 	 *
 	 * @param int $user_id
-	 * @param $product_id
+	 * @param integer $product_id
 	 *
 	 * @return array $orders
 	 */

includes/class-sensei.php

Doc Comments +4 added lines, -3 removed lines

@@ -832,7 +832,7 @@ 
      *
      * @since 1.4.5
      * @access public
-     * @param mixed $image_size
+     * @param string $image_size
      * @return string
      */
     public function get_image_size( $image_size ) {
@@ -1077,7 +1077,7 @@ 
      * @param   integer $wc_product_id Product ID or Variation ID
      * @param   string  $product_type  '' or 'variation'
      *
-     * @return   WC_Product $wc_product_object
+     * @return   integer $wc_product_object
      */
     public function sensei_get_woocommerce_product_object ( $wc_product_id = 0, $product_type = '' ) {
 
@@ -1101,7 +1101,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 ) {
 
@@ -1158,6 +1158,7 @@ 
          * Returns the "Configure" plugin action link to go directly to the plugin
          * settings page (if any)
          *
+         * @param string $plugin_id
          * @return string plugin configure link
          */
         public function get_settings_link( $plugin_id = null ) {