woothemes / woocommerce

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/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' );

includes/wc-cart-functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
  * @param int $product_or_variation_id contains the id of the product to add to the cart.
  * @param int $quantity contains the quantity of the item to add
  * @param array $data extra cart item data we want to pass into the item, including any data about the variation if applicable.
- * @return string|bool $cart_item_key that was added or false if validation failed.
+ * @return string|false $cart_item_key that was added or false if validation failed.
  */
 function wc_add_to_cart( $product_or_variation_id = 0, $quantity = 1, $data = array() ) {
 	try {

includes/wc-core-functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -128,7 +128,7 @@ 
  * WC_TEMPLATE_DEBUG_MODE will prevent overrides in themes from taking priority.
  *
  * @access public
- * @param mixed $slug
+ * @param string $slug
  * @param string $name (default: '')
  */
 function wc_get_template_part( $slug, $name = '' ) {
@@ -1447,7 +1447,7 @@ 
  *
  * @since 2.7.0
  * @param array      $list      List of objects or arrays
- * @param int|string $callback_or_field     Callback method from the object to place instead of the entire object
+ * @param string $callback_or_field     Callback method 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.
  * @return array Array of values.