sunnysideup / silverstripe-ecommerce

code/model/process/OrderProcessQueue.php

Doc Comments +1 added lines, -2 removed lines

@@ -150,7 +150,7 @@ 
      * If the order already exists, it will update the seconds and the creation  time.
      *
      * @param Order $order          [description]
-     * @param Int   $deferInSeconds [description]
+     * @param Int   $deferTimeInSeconds [description]
      */
     public function AddOrderToQueue($order, $deferTimeInSeconds)
     {
@@ -222,7 +222,6 @@ 
 
     /**
      * META METHOD: returns a list of orders to be processed
-     * @param int $limit total number of orders that can be retrieved at any one time
      * @return DataList (of orders)
      */
     public function OrdersToBeProcessed()

code/model/process/OrderStatusLogs/OrderStatusLog_DispatchPhysicalOrder.php

Doc Comments +1 added lines, -1 removed lines

@@ -94,7 +94,7 @@
     }
 
     /**
-     *@return string
+     *@return HTMLText
      **/
     public function CustomerNote()
     {

code/model/process/OrderStatusLogs/OrderStatusLog_PaymentCheck.php

Doc Comments +1 added lines, -1 removed lines

@@ -93,7 +93,7 @@
     }
 
     /**
-     * @return string
+     * @return HTMLText|null
      **/
     public function CustomerNote()
     {

code/model/process/OrderStep.php

Doc Comments +6 added lines, -5 removed lines

@@ -594,7 +594,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -613,7 +613,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if run correctly.
      **/
@@ -655,6 +655,7 @@ 
      *
      * @param string $code:       the name of the step to check
      * @param bool   $orIsEqualTo if set to true, this method will return TRUE if the step being checked is the current one
+     * @param string $code
      *
      * @return bool
      **/
@@ -902,7 +903,7 @@ 
     /**
      * Formatted answer for "hasCustomerMessage".
      *
-     * @return string
+     * @return DBField
      */
     public function ShowAsSummary()
     {
@@ -912,7 +913,7 @@ 
     /**
      *
      *
-     * @return string
+     * @return DBField
      */
     public function getShowAsSummary()
     {
@@ -972,7 +973,7 @@ 
     /**
      * Formatted answer for "hasCustomerMessage".
      *
-     * @return string
+     * @return DBField
      */
     public function NameAndDescription()
     {

code/model/process/OrderSteps/OrderStep_Confirmed.php

Doc Comments +3 added lines, -3 removed lines

@@ -30,7 +30,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -47,7 +47,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if run correctly.
      **/
@@ -61,7 +61,7 @@ 
      *
      * @param DataObject $order Order
      *
-     * @return DataObject | Null - DataObject = OrderStep
+     * @return OrderStep|null | Null - DataObject = OrderStep
      **/
     public function nextStep(Order $order)
     {

code/model/process/OrderSteps/OrderStep_Paid.php

Doc Comments +2 added lines, -2 removed lines

@@ -26,7 +26,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -43,7 +43,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if run correctly.
      **/

code/model/process/OrderSteps/OrderStep_Sent.php

Doc Comments +3 added lines, -3 removed lines

@@ -48,7 +48,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -65,9 +65,9 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
-     * @return bool - true if run correctly.
+     * @return boolean|null - true if run correctly.
      **/
     public function doStep(Order $order)
     {

code/model/process/OrderSteps/OrderStep_SentInvoice.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
       * NOTE: must have a payment (even if it is a fake payment).
       * The reason for this is if people pay straight away then they want to see the payment shown on their invoice.
       *
-      * @param Order object
+      * @param Order Order
       *
       * @return bool - true if the current step is ready to be run...
       **/

code/model/process/OrderSteps/OrderStep_SentReceipt.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/