woothemes / woocommerce

includes/api/class-wc-rest-payment-gateways-controller.php

Doc Comments +1 added lines

@@ -247,6 +247,7 @@
 
 	/**
 	 * Return settings associated with this payment gateway.
+	 * @param WC_Payment_Gateway $gateway
 	 */
 	public function get_settings( $gateway ) {
 		$settings = array();

includes/abstracts/abstract-wc-rest-controller.php

Doc Comments +1 added lines, -1 removed lines

@@ -246,7 +246,7 @@
 	 * Validate image_width based settings.
 	 *
 	 * @since 2.7.0
-	 * @param array $value
+	 * @param array $values
 	 * @param array $setting
 	 * @return string|WP_Error
 	 */

includes/abstracts/abstract-wc-item.php

Doc Comments +2 added lines, -2 removed lines

@@ -50,7 +50,7 @@ 
 
 	/**
 	 * Constructor.
-	 * @param int|object|array $read ID to load from the DB (optional) or already queried data.
+	 * @param integer $read ID to load from the DB (optional) or already queried data.
 	 */
 	public function __construct( $read = 0 ) {
 		parent::__construct( $read );
@@ -68,7 +68,7 @@ 
 
 	/**
 	 * Type checking
-	 * @param  string|array  $Type
+	 * @param  string|array  $type
 	 * @return boolean
 	 */
 	public function is_type( $type ) {

includes/class-wc-cart-item.php

Doc Comments +2 added lines, -2 removed lines

@@ -112,7 +112,7 @@ 
 
 	/**
 	 * Gets price of the product.
-	 * @return float
+	 * @return string
 	 */
 	public function get_tax_class() {
 		return $this->get_product() ? $this->get_product()->get_tax_class() : '';
@@ -194,7 +194,7 @@ 
 
 	/**
 	 * Set all data.
-	 * @param array $value
+	 * @param array $values
 	 */
 	public function set_data( $values ) {
 		if ( is_a( $values, 'WC_Cart_Item' ) ) {

includes/class-wc-cart-items.php

Doc Comments +3 added lines, -3 removed lines

@@ -47,7 +47,7 @@ 
 	 * Get an item by it's key.
 	 *
 	 * @param  string $item_key
-	 * @return WC_Item_Product|bool
+	 * @return integer
 	 */
 	public function get_item_by_key( $item_key ) {
 		return isset( $this->items[ $item_key ] ) ? $this->items[ $item_key ] : false;
@@ -55,7 +55,7 @@ 
 
 	/**
 	 * Get items.
-	 * @return array
+	 * @return WC_Item_Product[]
 	 */
 	public function get_items() {
 		return $this->items;
@@ -63,7 +63,7 @@ 
 
 	/**
 	 * Get removed items.
-	 * @return array
+	 * @return WC_Item_Product[]
 	 */
 	public function get_removed_items() {
 		return $this->removed_items;

includes/class-wc-cart.php

Doc Comments +3 added lines, -3 removed lines

@@ -145,7 +145,7 @@ 
 
 	/**
 	 * Returns the contents of the cart in an array.
-	 * @return array contents of the cart
+	 * @return WC_Item_Product[] contents of the cart
 	 */
 	public function get_cart() {
 		if ( ! did_action( 'wp_loaded' ) ) {
@@ -195,7 +195,7 @@ 
 
 	/**
 	 * Set the quantity for an item in the cart.
-	 * @param string	$cart_item_key	contains the id of the cart item
+	 * @param integer	$item_key	contains the id of the cart item
 	 * @param int		$quantity		contains the quantity of the item
 	 */
 	public function set_quantity( $item_key, $quantity = 1, $deprecated = true ) {
@@ -219,7 +219,7 @@ 
 	/**
 	 * Remove a single coupon by code.
 	 * @param  string $coupon_code Code of the coupon to remove
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function remove_coupon( $coupon_code ) {
 		return $this->coupons->remove_coupon( $coupon_code );

includes/class-wc-tax.php

Doc Comments +3 added lines, -2 removed lines

@@ -594,6 +594,7 @@ 
 	 * Return true/false depending on if a rate is a compound rate.
 	 *
 	 * @param   int		key
+	 * @param integer $key
 	 * @return  bool
 	 */
 	public static function is_compound( $key ) {
@@ -604,7 +605,7 @@ 
 	/**
 	 * Return a given rates label.
 	 *
-	 * @param mixed $key_or_rate Tax rate ID, or the db row itself in object format
+	 * @param integer $key_or_rate Tax rate ID, or the db row itself in object format
 	 * @return  string
 	 */
 	public static function get_rate_label( $key_or_rate ) {
@@ -649,7 +650,7 @@ 
 	 * Get a rates code. Code is made up of COUNTRY-STATE-NAME-Priority. E.g GB-VAT-1, US-AL-TAX-1.
 	 *
 	 * @access public
-	 * @param mixed $key_or_rate Tax rate ID, or the db row itself in object format
+	 * @param integer $key_or_rate Tax rate ID, or the db row itself in object format
 	 * @return string
 	 */
 	public static function get_rate_code( $key_or_rate ) {

includes/legacy/abstract-wc-legacy-order.php

Doc Comments +2 added lines, -2 removed lines

@@ -40,7 +40,6 @@ 
 
 	/**
 	 * Add a tax row to the order.
-	 * @param array $args
 	 * @param int $tax_amount amount of tax.
 	 * @param int $shipping_tax_amount shipping amount.
 	 * @return int order item ID
@@ -64,6 +63,7 @@ 
 	/**
 	 * Add a shipping row to the order.
 	 * @param WC_Shipping_Rate shipping_rate
+	 * @param WC_Shipping_Rate $shipping_rate
 	 * @return int order item ID
 	 */
 	public function add_shipping( $shipping_rate ) {
@@ -86,7 +86,7 @@ 
 	/**
 	 * Add a fee to the order.
 	 * Order must be saved prior to adding items.
-	 * @param object $fee
+	 * @param stdClass $fee
 	 * @return int updated order item ID
 	 */
 	public function add_fee( $fee ) {

includes/legacy/class-wc-legacy-cart.php

Doc Comments +1 added lines, -1 removed lines

@@ -179,7 +179,7 @@
 	 * @param int $variation_id
 	 * @param array $variation attribute values
 	 * @param array $cart_item_data extra cart item data we want to pass into the item
-	 * @return string|bool $cart_item_key
+	 * @return string|false $cart_item_key
 	 */
 	public function add_to_cart( $product_id = 0, $quantity = 1, $variation_id = 0, $variation = array(), $cart_item_data = array() ) {
 		_deprecated_function( 'WC_Cart::add_to_cart', '2.7', 'wc_add_to_cart' );