Cleanup all the @see's

barryvdh · barryvdh · commit 301f680c94aa · 2018-11-01T13:56:31.000+01:00
diff --git a/src/Common/AbstractGateway.php b/src/Common/AbstractGateway.php
@@ -40,7 +40,6 @@
  *
  * For further code examples see the *omnipay-example* repository on github.
  *
- * @see GatewayInterface
  */
 abstract class AbstractGateway implements GatewayInterface
 {
@@ -290,7 +289,6 @@ public function supportsUpdateCard()
      *   $myRequest = $gw->myRequest($someParameters);
      * </code>
      *
-     * @see \Omnipay\Common\Message\AbstractRequest
      * @param string $class The request class name
      * @param array $parameters
      * @return \Omnipay\Common\Message\AbstractRequest
diff --git a/src/Common/CreditCard.php b/src/Common/CreditCard.php
@@ -151,7 +151,6 @@ public function __construct($parameters = null)
      * Note: The fact that this class knows about a particular card brand does not imply
      * that your gateway supports it.
      *
-     * @see self::$supported_cards
      * @return array
      */
     public function getSupportedBrands()
diff --git a/src/Common/GatewayFactory.php b/src/Common/GatewayFactory.php
@@ -26,7 +26,6 @@
  *   $gateway = Omnipay::create('ExpressGateway');
  * </code>
  *
- * @see Omnipay\Omnipay
  */
 class GatewayFactory
 {
diff --git a/src/Common/GatewayInterface.php b/src/Common/GatewayInterface.php
@@ -11,7 +11,6 @@
  * This interface class defines the standard functions that any
  * Omnipay gateway needs to define.
  *
- * @see AbstractGateway
  *
  * @method \Omnipay\Common\Message\NotificationInterface acceptNotification(array $options = array()) (Optional method)
  *         Receive and handle an instant payment notification (IPN)
diff --git a/src/Common/Issuer.php b/src/Common/Issuer.php
@@ -29,18 +29,14 @@ class Issuer
     
     /**
      * The ID of a payment method that the issuer belongs to.
-     *
-     * @see PaymentMethod
-     *
+     **
      * @var string
      */
     protected $paymentMethod;
 
     /**
      * Create a new Issuer
      *
-     * @see PaymentMethod
-     *
      * @param string      $id            The identifier of this issuer
      * @param string      $name          The name of this issuer
      * @param string|null $paymentMethod The ID of a payment method this issuer belongs to
@@ -75,8 +71,6 @@ public function getName()
     /**
      * The ID of a payment method this issuer belongs to
      *
-     * @see PaymentMethod
-     *
      * @return string
      */
     public function getPaymentMethod()
diff --git a/src/Common/Item.php b/src/Common/Item.php
@@ -12,7 +12,6 @@
  *
  * This class defines a single cart item in the Omnipay system.
  *
- * @see ItemInterface
  */
 class Item implements ItemInterface
 {
diff --git a/src/Common/ItemBag.php b/src/Common/ItemBag.php
@@ -11,14 +11,12 @@
  * This class defines a bag (multi element set or array) of single cart items
  * in the Omnipay system.
  *
- * @see Item
  */
 class ItemBag implements \IteratorAggregate, \Countable
 {
     /**
      * Item storage
      *
-     * @see Item
      *
      * @var array
      */
@@ -37,7 +35,6 @@ public function __construct(array $items = array())
     /**
      * Return all the items
      *
-     * @see Item
      *
      * @return array An array of items
      */
@@ -49,7 +46,6 @@ public function all()
     /**
      * Replace the contents of this bag with the specified items
      *
-     * @see Item
      *
      * @param array $items An array of items
      */
@@ -65,7 +61,6 @@ public function replace(array $items = array())
     /**
      * Add an item to the bag
      *
-     * @see Item
      *
      * @param ItemInterface|array $item An existing item, or associative array of item parameters
      */
diff --git a/src/Common/Message/AbstractRequest.php b/src/Common/Message/AbstractRequest.php
@@ -62,8 +62,6 @@
  *   // now do something with the $myResponse object, test for success, etc.
  * </code>
  *
- * @see RequestInterface
- * @see AbstractResponse
  */
 abstract class AbstractRequest implements RequestInterface
 {
diff --git a/src/Common/Message/AbstractResponse.php b/src/Common/Message/AbstractResponse.php
@@ -26,7 +26,6 @@
  *   // now do something with the $myResponse object, test for success, etc.
  * </code>
  *
- * @see ResponseInterface
  */
 abstract class AbstractResponse implements ResponseInterface
 {
diff --git a/src/Common/Message/FetchIssuersResponseInterface.php b/src/Common/Message/FetchIssuersResponseInterface.php
@@ -15,8 +15,6 @@
  * This happens when the gateway needs the customer to choose a
  * card issuer.
  *
- * @see ResponseInterface
- * @see Omnipay\Common\Issuer
  */
 interface FetchIssuersResponseInterface extends ResponseInterface
 {
diff --git a/src/Common/Message/FetchPaymentMethodsResponseInterface.php b/src/Common/Message/FetchPaymentMethodsResponseInterface.php
@@ -15,8 +15,6 @@
  * This happens when the gateway needs the customer to choose a
  * payment method.
  *
- * @see ResponseInterface
- * @see Omnipay\Common\PaymentMethod
  */
 interface FetchPaymentMethodsResponseInterface extends ResponseInterface
 {
diff --git a/src/Common/Message/NotificationInterface.php b/src/Common/Message/NotificationInterface.php
@@ -21,8 +21,8 @@ public function getTransactionReference();
     /**
      * Was the transaction successful?
      *
-     * @return string Transaction status, one of {@see STATUS_COMPLETED}, {@see #STATUS_PENDING},
-     * or {@see #STATUS_FAILED}.
+     * @return string Transaction status, one of {@link NotificationInterface::STATUS_COMPLETED},
+     * {@link NotificationInterface::STATUS_PENDING}, or {@link NotificationInterface::STATUS_FAILED}.
      */
     public function getTransactionStatus();
 
diff --git a/src/Common/Message/RedirectResponseInterface.php b/src/Common/Message/RedirectResponseInterface.php
@@ -13,7 +13,6 @@
  * interface class with some extra functions relating to the
  * specifics of a redirect response from the gateway.
  *
- * @see ResponseInterface
  */
 interface RedirectResponseInterface extends ResponseInterface
 {
diff --git a/src/Common/Message/RequestInterface.php b/src/Common/Message/RequestInterface.php
@@ -11,7 +11,6 @@
  * This interface class defines the standard functions that any Omnipay request
  * interface needs to be able to provide.  It is an extension of MessageInterface.
  *
- * @see MessageInterface
  */
 interface RequestInterface extends MessageInterface
 {
diff --git a/src/Common/Message/ResponseInterface.php b/src/Common/Message/ResponseInterface.php
@@ -11,7 +11,6 @@
  * This interface class defines the standard functions that any Omnipay response
  * interface needs to be able to provide.  It is an extension of MessageInterface.
  *
- * @see MessageInterface
  */
 interface ResponseInterface extends MessageInterface
 {
diff --git a/src/Common/PaymentMethod.php b/src/Common/PaymentMethod.php
@@ -10,7 +10,6 @@
  *
  * This class defines a payment method to be used in the Omnipay system.
  *
- * @see Issuer
  */
 class PaymentMethod
 {
@@ -19,8 +18,6 @@ class PaymentMethod
      * The ID of the payment method.  Used as the payment method ID in the
      * Issuer class.
      *
-     * @see Issuer
-     *
      * @var string
      */
     protected $id;
diff --git a/src/Omnipay.php b/src/Omnipay.php
@@ -50,7 +50,7 @@
  * @method static \Omnipay\Common\GatewayInterface create(string $class, ClientInterface $httpClient = null, \Symfony\Component\HttpFoundation\Request $httpRequest = null)
  * @codingStandardsIgnoreEnd
  *
- * @see Omnipay\Common\GatewayFactory
+ * @see \Omnipay\Common\GatewayFactory
  */
 class Omnipay
 {

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,6 @@`
`40`	`40`	`*`
`41`	`41`	`* For further code examples see the omnipay-example repository on github.`
`42`	`42`	`*`
`43`		`- * @see GatewayInterface`
`44`	`43`	`*/`
`45`	`44`	`abstract class AbstractGateway implements GatewayInterface`
`46`	`45`	`{`
`@@ -290,7 +289,6 @@ public function supportsUpdateCard()`
`290`	`289`	`* $myRequest = $gw->myRequest($someParameters);`
`291`	`290`	`* </code>`
`292`	`291`	`*`
`293`		`- * @see \Omnipay\Common\Message\AbstractRequest`
`294`	`292`	`* @param string $class The request class name`
`295`	`293`	`* @param array $parameters`
`296`	`294`	`* @return \Omnipay\Common\Message\AbstractRequest`
Original file line number	Diff line number	Diff line change
`@@ -151,7 +151,6 @@ public function __construct($parameters = null)`
`151`	`151`	`* Note: The fact that this class knows about a particular card brand does not imply`
`152`	`152`	`* that your gateway supports it.`
`153`	`153`	`*`
`154`		`- * @see self::$supported_cards`
`155`	`154`	`* @return array`
`156`	`155`	`*/`
`157`	`156`	`public function getSupportedBrands()`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,6 @@`
`26`	`26`	`* $gateway = Omnipay::create('ExpressGateway');`
`27`	`27`	`* </code>`
`28`	`28`	`*`
`29`		`- * @see Omnipay\Omnipay`
`30`	`29`	`*/`
`31`	`30`	`class GatewayFactory`
`32`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@`
`11`	`11`	`* This interface class defines the standard functions that any`
`12`	`12`	`* Omnipay gateway needs to define.`
`13`	`13`	`*`
`14`		`- * @see AbstractGateway`
`15`	`14`	`*`
`16`	`15`	`* @method \Omnipay\Common\Message\NotificationInterface acceptNotification(array $options = array()) (Optional method)`
`17`	`16`	`* Receive and handle an instant payment notification (IPN)`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,6 @@`
`12`	`12`	`*`
`13`	`13`	`* This class defines a single cart item in the Omnipay system.`
`14`	`14`	`*`
`15`		`- * @see ItemInterface`
`16`	`15`	`*/`
`17`	`16`	`class Item implements ItemInterface`
`18`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,14 +11,12 @@`
`11`	`11`	`* This class defines a bag (multi element set or array) of single cart items`
`12`	`12`	`* in the Omnipay system.`
`13`	`13`	`*`
`14`		`- * @see Item`
`15`	`14`	`*/`
`16`	`15`	`class ItemBag implements \IteratorAggregate, \Countable`
`17`	`16`	`{`
`18`	`17`	`/**`
`19`	`18`	`* Item storage`
`20`	`19`	`*`
`21`		`- * @see Item`
`22`	`20`	`*`
`23`	`21`	`* @var array`
`24`	`22`	`*/`
`@@ -37,7 +35,6 @@ public function __construct(array $items = array())`
`37`	`35`	`/**`
`38`	`36`	`* Return all the items`
`39`	`37`	`*`
`40`		`- * @see Item`
`41`	`38`	`*`
`42`	`39`	`* @return array An array of items`
`43`	`40`	`*/`
`@@ -49,7 +46,6 @@ public function all()`
`49`	`46`	`/**`
`50`	`47`	`* Replace the contents of this bag with the specified items`
`51`	`48`	`*`
`52`		`- * @see Item`
`53`	`49`	`*`
`54`	`50`	`* @param array $items An array of items`
`55`	`51`	`*/`
`@@ -65,7 +61,6 @@ public function replace(array $items = array())`
`65`	`61`	`/**`
`66`	`62`	`* Add an item to the bag`
`67`	`63`	`*`
`68`		`- * @see Item`
`69`	`64`	`*`
`70`	`65`	`* @param ItemInterface\|array $item An existing item, or associative array of item parameters`
`71`	`66`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -62,8 +62,6 @@`
`62`	`62`	`* // now do something with the $myResponse object, test for success, etc.`
`63`	`63`	`* </code>`
`64`	`64`	`*`
`65`		`- * @see RequestInterface`
`66`		`- * @see AbstractResponse`
`67`	`65`	`*/`
`68`	`66`	`abstract class AbstractRequest implements RequestInterface`
`69`	`67`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,6 @@`
`15`	`15`	`* This happens when the gateway needs the customer to choose a`
`16`	`16`	`* card issuer.`
`17`	`17`	`*`
`18`		`- * @see ResponseInterface`
`19`		`- * @see Omnipay\Common\Issuer`
`20`	`18`	`*/`
`21`	`19`	`interface FetchIssuersResponseInterface extends ResponseInterface`
`22`	`20`	`{`