Add more specifications.

spryker · Dec 6, 2016 · f1286c1 · f1286c1
1 parent a6f6486
commit f1286c1
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 42 deletions.
diff --git a/src/Spryker/Zed/Ratepay/Business/RatepayFacade.php b/src/Spryker/Zed/Ratepay/Business/RatepayFacade.php
@@ -23,8 +23,7 @@ class RatepayFacade extends AbstractFacade implements RatepayFacadeInterface
 {
 
     /**
-     * Specification:
-     * - Saves order payment method data according to quote and checkout response transfer data.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -41,8 +40,7 @@ public function saveOrderPayment(QuoteTransfer $quoteTransfer, CheckoutResponseT
     }
 
     /**
-     * Specification:
-     * - Performs the init payment request to RatePAY Gateway to retrieve transaction data.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -74,8 +72,7 @@ public function postSaveHook(QuoteTransfer $quoteTransfer, CheckoutResponseTrans
     }
 
     /**
-     * Specification:
-     * - Performs check the customer and order details payment request to RatePAY Gateway.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -92,8 +89,7 @@ public function requestPayment(RatepayPaymentRequestTransfer $ratepayPaymentRequ
     }
 
     /**
-     * Specification:
-     * - Updates paymentMethod in dataBase according response from paymentRequest
+     * {@inheritdoc}
      *
      * @api
      *
@@ -111,8 +107,7 @@ public function updatePaymentMethodByPaymentResponse(RatepayResponseTransfer $ra
     }
 
     /**
-     * Specification:
-     * - Performs the payment confirmation request to RatePAY Gateway.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -129,8 +124,7 @@ public function confirmPayment(OrderTransfer $orderTransfer)
     }
 
     /**
-     * Specification:
-     * - Performs the delivery confirmation request to RatePAY Gateway.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -152,8 +146,7 @@ public function confirmDelivery(
     }
 
     /**
-     * Specification:
-     * - Performs the cancel payment request to RatePAY Gateway.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -175,8 +168,7 @@ public function cancelPayment(
     }
 
     /**
-     * Specification:
-     * - Performs the refund payment request to RatePAY Gateway.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -198,8 +190,7 @@ public function refundPayment(
     }
 
     /**
-     * Specification:
-     * - Performs the installment payment method calculator configuration request to RatePAY Gateway.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -216,8 +207,7 @@ public function installmentConfiguration(QuoteTransfer $quoteTransfer)
     }
 
     /**
-     * Specification:
-     * - Performs the installment payment method calculator calculation request to RatePAY Gateway.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -234,6 +224,8 @@ public function installmentCalculation(QuoteTransfer $quoteTransfer)
     }
 
     /**
+     * {@inheritdoc}
+     *
      * @api
      *
      * @param \Generated\Shared\Transfer\OrderTransfer $orderTransfer
@@ -249,8 +241,7 @@ public function isPaymentRequestSuccess(OrderTransfer $orderTransfer)
     }
 
     /**
-     * Specification:
-     * - Checks if the payment confirmation API request got success response from RatePAY Gateway.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -267,8 +258,7 @@ public function isPaymentConfirmed(OrderTransfer $orderTransfer)
     }
 
     /**
-     * Specification:
-     * - Checks if the delivery confirmation API request got success response from RatePAY Gateway.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -285,8 +275,7 @@ public function isDeliveryConfirmed(OrderTransfer $orderTransfer)
     }
 
     /**
-     * Specification:
-     * - Checks if the payment refund API request got success response from RatePAY Gateway.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -303,8 +292,7 @@ public function isRefundApproved(OrderTransfer $orderTransfer)
     }
 
     /**
-     * Specification:
-     * - Checks if the payment cancellation API request got success response from RatePAY Gateway.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -321,8 +309,7 @@ public function isCancellationConfirmed(OrderTransfer $orderTransfer)
     }
 
     /**
-     * Specification:
-     * - Expands cart items with necessary for Ratepay information (short_description, long_description, etc).
+     * {@inheritdoc}
      *
      * @api
      *
@@ -336,8 +323,7 @@ public function expandItems(CartChangeTransfer $change)
     }
 
     /**
-     * Specification:
-     * - Installs bundle translations to project glossary.
+     * {@inheritdoc}
      *
      * @api
      *
@@ -351,8 +337,7 @@ public function install(MessengerInterface $messenger = null)
     }
 
     /**
-     * Specification:
-     * - Retrieves profile data from Ratepay Gateway.
+     * {@inheritdoc}
      *
      * @api
      *

diff --git a/src/Spryker/Zed/Ratepay/Business/RatepayFacadeInterface.php b/src/Spryker/Zed/Ratepay/Business/RatepayFacadeInterface.php
@@ -23,7 +23,7 @@ interface RatepayFacadeInterface
 
     /**
      * Specification:
-     * - Saves order ratepay payment method data according to quote and checkout response transfer data.
+     * - Saves order payment method data according to quote and checkout response transfer data.
      *
      * @api
      *
@@ -36,7 +36,7 @@ public function saveOrderPayment(QuoteTransfer $quoteTransfer, CheckoutResponseT
 
     /**
      * Specification:
-     * - Performs init payment request to Ratepay Getaway to retrieve transaction data.
+     * - Performs init payment request to RatePAY Getaway to retrieve transaction data.
      *
      * @api
      *
@@ -48,7 +48,7 @@ public function initPayment(RatepayPaymentInitTransfer $ratepayPaymentInitTransf
 
     /**
      * Specification:
-     * - Performs check the customer and order details payment request to RatePAY Gateway.
+     * - Performs the init payment request to RatePAY Gateway to retrieve transaction data.
      *
      * @api
      *
@@ -103,7 +103,7 @@ public function confirmDelivery(
 
     /**
      * Specification:
-     * - Performs cancel payment request to RatePAY Gateway.
+     * - Performs the cancel payment request to RatePAY Gateway.
      *
      * @api
      *
@@ -139,7 +139,7 @@ public function refundPayment(
 
     /**
      * Specification:
-     * - Performs installment payment method calculator configuration request to RatePAY Gateway.
+     * - Performs the installment payment method calculator configuration request to RatePAY Gateway.
      *
      * @api
      *
@@ -151,7 +151,7 @@ public function installmentConfiguration(QuoteTransfer $quoteTransfer);
 
     /**
      * Specification:
-     * - Performs installment payment method calculator calculation request to RatePAY Gateway.
+     * - Performs the installment payment method calculator calculation request to RatePAY Gateway.
      *
      * @api
      *
@@ -223,7 +223,7 @@ public function isCancellationConfirmed(OrderTransfer $orderTransfer);
 
     /**
      * Specification:
-     * - Expands cart items with necessary for Ratepay information (short_description, long_description, etc).
+     * - Expands cart items with necessary for RatePAY information (short_description, long_description, etc).
      *
      * @api
      *
@@ -257,7 +257,7 @@ public function install(MessengerInterface $messenger = null);
 
     /**
      * Specification:
-     * - Retrieves profile data from Ratepay Gateway.
+     * - Retrieves profile data from RatePAY Gateway.
      *
      * @api
      *