burnbright / silverstripe-shop

code/account/OrderManipulation.php

Doc Comments +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
      * Get the order via url 'ID' or form submission 'OrderID'.
      * It will check for permission based on session stored ids or member id.
      *
-     * @return the order
+     * @return DataObject|null order
      */
     public function orderfromid()
     {
@@ -121,7 +121,7 @@ 
 
     /**
      * Build a form for cancelling, or retrying payment for a placed order.
-     * @return Form
+     * @return null|OrderActionsForm
      */
     public function ActionsForm()
     {

code/account/ShopMemberFactory.php

Doc Comments +1 added lines, -1 removed lines

@@ -9,7 +9,7 @@
      *
      * @throws ValidationException
      * @param $data - map of member data
-     * @return Member|boolean - new member (not saved to db), or false if there is an error.
+     * @return Member - new member (not saved to db), or false if there is an error.
      */
     public function create($data)
     {

code/cart/CartEditField.php

Doc Comments -1 removed lines

@@ -82,7 +82,6 @@
     /**
      * Add quantity, variation and remove fields to the
      * item set.
-     * @param SS_List $items
      */
     protected function editableItems()
     {

code/checkout/Checkout.php

Doc Comments +1 added lines

@@ -166,6 +166,7 @@
 
     /**
      * Store a new error & return false;
+     * @param string $message
      */
     protected function error($message)
     {

code/checkout/CheckoutPage.php

Doc Comments +2 added lines

@@ -21,6 +21,8 @@
      * Returns the link to the checkout page on this site
      *
      * @param boolean $urlSegment If set to TRUE, only returns the URLSegment field
+     * @param string $action
+     * @param integer $id
      * @return string Link to checkout page
      */
     public static function find_link($urlSegment = false, $action = null, $id = null)

code/checkout/components/CheckoutComponent.php

Doc Comments -1 removed lines

@@ -22,7 +22,6 @@
      * Get form fields for manipulating the current order,
      * according to the responsibilty of this component.
      *
-     * @param  Form $form the form being updated
      * @throws Exception
      * @return FieldList fields for manipulating order
      */

code/checkout/OrderProcessor.php

Doc Comments +4 added lines, -2 removed lines

@@ -177,7 +177,7 @@ 
 
     /**
      * Determine if an order can be placed.
-     * @param boolean $order
+     * @param Order $order
      */
     public function canPlace(Order $order)
     {
@@ -201,7 +201,6 @@ 
 
     /**
      * Takes an order from being a cart to awaiting payment.
-     * @param Member $member - assign a member to the order
      * @return boolean - success/failure
      */
     public function placeOrder()
@@ -290,6 +289,9 @@ 
         return $this->error;
     }
 
+    /**
+     * @param string $message
+     */
     private function error($message)
     {
         $this->error = $message;

code/cms/ShopConfig.php

Doc Comments +3 added lines

@@ -48,6 +48,9 @@
         $countriestab->setTitle("Allowed Countries");
     }
 
+    /**
+     * @return string
+     */
     public static function get_base_currency()
     {
         return self::config()->base_currency;

code/model/Buyable.php

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,6 @@ 
      * Create a new OrderItem to add to an order.
      *
      * @param int $quantity
-     * @param boolean $write
      * @return OrderItem new OrderItem object
      */
     public function createItem($quantity = 1, $filter = array());
@@ -28,6 +27,7 @@ 
      *
      * @throws ShopBuyableException
      *
+     * @param DataObject $member
      * @return boolean
      */
     public function canPurchase($member = null, $quantity = 1);