Commit 9c6a22e5 authored by bojanz's avatar bojanz

Use the standard '@return ' in docblocks documenting fluent interfaces.

parent 3cc34bc3
......@@ -38,8 +38,7 @@ interface LineItemInterface extends EntityChangedInterface, EntityInterface, Ent
* @param string $status
* The line item status.
*
* @return \Drupal\commerce_line_item\LineItemInterface
* The called line item entity.
* @return $this
*/
public function setStatus($status);
......@@ -57,8 +56,7 @@ interface LineItemInterface extends EntityChangedInterface, EntityInterface, Ent
* @param int $timestamp
* The line item creation timestamp.
*
* @return \Drupal\commerce_line_item\LineItemInterface
* The called line item entity.
* @return $this
*/
public function setCreatedTime($timestamp);
......@@ -76,8 +74,7 @@ interface LineItemInterface extends EntityChangedInterface, EntityInterface, Ent
* @param int $timestamp
* The UNIX timestamp of when this revision was created.
*
* @return \Drupal\commerce_line_item\LineItemInterface
* The called line item entity.
* @return $this
*/
public function setRevisionCreationTime($timestamp);
......@@ -95,8 +92,7 @@ interface LineItemInterface extends EntityChangedInterface, EntityInterface, Ent
* @param int $uid
* The user ID of the revision author.
*
* @return \Drupal\commerce_line_item\LineItemInterface
* The called line item entity.
* @return $this
*/
public function setRevisionAuthorId($uid);
......@@ -114,8 +110,7 @@ interface LineItemInterface extends EntityChangedInterface, EntityInterface, Ent
* @param array $data
* An array of additional data.
*
* @return \Drupal\commerce_line_item\LineItemInterface
* The called line item entity.
* @return $this
*/
public function setData($data);
......
......@@ -31,8 +31,7 @@ interface OrderInterface extends EntityStoreInterface, EntityChangedInterface, E
* @param string $orderNumber
* The order number.
*
* @return \Drupal\commerce_order\OrderInterface
* The called order entity.
* @return $this
*/
public function setOrderNumber($orderNumber);
......@@ -58,8 +57,7 @@ interface OrderInterface extends EntityStoreInterface, EntityChangedInterface, E
* @param string $status
* The order status.
*
* @return \Drupal\commerce_order\OrderInterface
* The called order entity.
* @return $this
*/
public function setStatus($status);
......@@ -77,8 +75,7 @@ interface OrderInterface extends EntityStoreInterface, EntityChangedInterface, E
* @param int $timestamp
* The order creation timestamp.
*
* @return \Drupal\commerce_order\OrderInterface
* The called order entity.
* @return $this
*/
public function setCreatedTime($timestamp);
......@@ -96,8 +93,7 @@ interface OrderInterface extends EntityStoreInterface, EntityChangedInterface, E
* @param array $lineItems
* The line items associated with this order.
*
* @return \Drupal\commerce_order\OrderInterface
* The called order entity.
* @return $this
*/
public function setLineItems($lineItems);
......@@ -115,8 +111,7 @@ interface OrderInterface extends EntityStoreInterface, EntityChangedInterface, E
* @param array $data
* An array of additional data.
*
* @return \Drupal\commerce_order\OrderInterface
* The called order entity.
* @return $this
*/
public function setData($data);
......@@ -134,8 +129,7 @@ interface OrderInterface extends EntityStoreInterface, EntityChangedInterface, E
* @param string $hostname
* The IP address to associate to this order.
*
* @return \Drupal\commerce_order\OrderInterface
* The called order entity.
* @return $this
*/
public function setHostname($hostname);
......@@ -153,8 +147,7 @@ interface OrderInterface extends EntityStoreInterface, EntityChangedInterface, E
* @param string $mail
* The e-mail address associated with the order.
*
* @return \Drupal\commerce_order\OrderInterface
* The called order entity.
* @return $this
*/
public function setEmail($mail);
......
......@@ -31,8 +31,7 @@ interface StoreInterface extends EntityInterface, EntityOwnerInterface {
* @param string $name
* The store name.
*
* @return \Drupal\commerce_store\StoreInterface
* The class instance that this method is called on.
* @return $this
*/
public function setName($name);
......@@ -50,8 +49,7 @@ interface StoreInterface extends EntityInterface, EntityOwnerInterface {
* @param string $mail
* The store e-mail.
*
* @return \Drupal\commerce_store\StoreInterface
* The class instance that this method is called on.
* @return $this
*/
public function setEmail($mail);
......@@ -69,8 +67,7 @@ interface StoreInterface extends EntityInterface, EntityOwnerInterface {
* @param \Drupal\commerce_price\CurrencyInterface $currency
* The default store currency.
*
* @return \Drupal\commerce_store\StoreInterface
* The class instance that this method is called on.
* @return $this
*/
public function setDefaultCurrency(CurrencyInterface $currency);
......@@ -88,8 +85,7 @@ interface StoreInterface extends EntityInterface, EntityOwnerInterface {
* @param string $currencyCode
* The default store currency code.
*
* @return \Drupal\commerce_store\StoreInterface
* The class instance that this method is called on.
* @return $this
*/
public function setDefaultCurrencyCode($currencyCode);
......@@ -107,8 +103,7 @@ interface StoreInterface extends EntityInterface, EntityOwnerInterface {
* @param \Drupal\address\AddressInterface $address
* The store address.
*
* @return \Drupal\commerce_store\StoreInterface
* The class instance that this method is called on.
* @return $this
*/
public function setAddress(AddressInterface $address);
......@@ -128,8 +123,7 @@ interface StoreInterface extends EntityInterface, EntityOwnerInterface {
* @param array $countries
* A list of country codes.
*
* @return \Drupal\commerce_store\StoreInterface
* The class instance that this method is called on.
* @return $this
*/
public function setCountries(array $countries);
......
......@@ -23,10 +23,10 @@ interface StoreTypeInterface extends ConfigEntityInterface {
public function getDescription();
/**
* Sets the description of the store type.
* Sets the store type description.
*
* @param string $description
* The new description.
* The store type description.
*
* @return $this
*/
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment