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