sunnysideup / silverstripe-ecommerce

code/model/process/OrderStep.php

Doc Comments +11 added lines, -5 removed lines

@@ -651,7 +651,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -670,7 +670,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if run correctly.
      **/
@@ -714,6 +714,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
      **/
@@ -966,6 +967,11 @@ 
         return $this->hasCustomerMessage() ?  _t('OrderStep.YES', 'Yes') :  _t('OrderStep.NO', 'No');
     }
 
+    /**
+     * @param Order $order
+     *
+     * @return boolean|string
+     */
     public function CalculatedEmailSubject($order = null)
     {
         return $this->EmailSubject;
@@ -979,7 +985,7 @@ 
     /**
      * Formatted answer for "hasCustomerMessage".
      *
-     * @return string
+     * @return DBField
      */
     public function ShowAsSummary()
     {
@@ -989,7 +995,7 @@ 
     /**
      *
      *
-     * @return string
+     * @return DBField
      */
     public function getShowAsSummary()
     {
@@ -1049,7 +1055,7 @@ 
     /**
      * Formatted answer for "hasCustomerMessage".
      *
-     * @return string
+     * @return DBField
      */
     public function NameAndDescription()
     {

code/model/process/OrderSteps/OrderStep_Sent.php

Doc Comments +9 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
      *
      * @see Order::doNextStatus
      *
-     * @param Order object
+     * @param Order Order
      *
      * @return bool - true if the current step is ready to be run...
      **/
@@ -89,9 +89,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)
     {
@@ -163,6 +163,9 @@ 
         return _t('OrderStep.SENT_DESCRIPTION', 'During this step we record the delivery details for the order such as the courrier ticket number and whatever else is relevant.');
     }
 
+    /**
+     * @param Order $order
+     */
     public function CalculatedEmailSubject($order = null)
     {
         $v = null;
@@ -176,6 +179,9 @@ 
         return $v;
     }
 
+    /**
+     * @param Order $order
+     */
     public function CalculatedCustomerMessage($order = null)
     {
         $v = null;