Documented the Order class with javadoc tags.

Author: ProgrammingKiddo

src/main/java/coreapi/Order.java

@@ -1,5 +1,6 @@
 /**
- * 
+ * @author Borja
+ * @version 0.2
  */
 package coreapi;
 
@@ -9,12 +10,61 @@
 
 public interface Order {
 
+	/**
+	 * Returns the combined cost of the whole order.
+	 * Takes into account which products comprised the order, and how many of each of them.
+	 * @return the cost of the order.
+	 */
 	public float totalCost();
+	/**
+	 * Returns the unique Id assigned to this order.
+	 * Each Order has a unique identifier within the system. Two different orders cannot
+	 * have the same id at any time.
+	 * @return the order Id.
+	 * @see OrderFactory
+	 */
 	public int getId();
+	/**
+	 * Returns the timestamp representing the date when the order was created.
+	 * @return timestamp from the creation of the order
+	 * @see Date
+	 */
 	public Date getDate();
+	/**
+	 * Returns the constant corresponding to the current state of the order,
+	 * as determined by the Enum <code>OrderStatus</code>.
+	 * @return the current state of the order.
+	 * @see OrderStatus
+	 */
 	public OrderStatus getStatus();
+	/**
+	 * Returns a read-only list of the products contained in this order.
+	 * The list does NOT contain how many of each product is contained within the order.
+	 * @return the list of products in this order.
+	 * @see List
+	 * @see Product
+	 */
 	public List<Product> getProducts();
+	/**
+	 * Returns a map containing the products contained in this order,
+	 * and how many of each of them is stored.
+	 * @return the map containing the quantity of each product in the order
+	 * @see Map
+	 */
 	public Map<Product, Integer> getBasket();
+	/**
+	 * Returns how much of a certain product is contained within this order.
+	 * If the product isn't contained in this order, the return value is zero.
+	 * @param id The id of the product to check.
+	 * @return the amount of a certain product in this order.
+	 */
 	public int checkProductQuantity(int id);
+	/**
+	 * Returns whether or not the product passed as parameter is contained in this order or not.
+	 * The return value is <code>true</code> if there is at least 1 unit of the product in this order,
+	 * and <code>false</code> if there is none.
+	 * @param id The id of the product to check.
+	 * @return true if the order contains the specified product.
+	 */
 	public boolean containsProduct(int id);
 }