diff --git a/docs/AboutUs.md b/docs/AboutUs.md index d183b7f991..1b6824c19a 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -3,7 +3,7 @@ Display | Name | Github Profile | Portfolio --------|:--------:|:----------------------------------------:|:---------: ![](images/aboutUs/shanice.jpg) | Shanice | [Github](https://github.com/ShaniceTang) | [Portfolio](team/shanicetang.md) -![](https://via.placeholder.com/100.png?text=Photo) | Naychi | [Github](https://github.com/NaychiMin/tp) | [Portfolio](team/naychimin.md) +![](images/aboutUs/naychimin.png) | Naychi | [Github](https://github.com/NaychiMin/tp) | [Portfolio](team/naychimin.md) ![](https://via.placeholder.com/100.png?text=Photo) | Zi Yi | [Github](https://github.com/ziyi105) | [Portfolio](team/ziyi105.md) | Dexter Hoon | [Github](https://github.com/DextheChik3n) | [Portfolio](team/dexthechik3n.md) ![](https://via.placeholder.com/100.png?text=Photo) | Chua Zhong Heng | [Github](https://github.com/Cazh1/tp) | [Portfolio](team/cazh1.md) \ No newline at end of file diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index c8c4307d91..75d74f9645 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -259,7 +259,7 @@ To end off the command, `ui.showPreviousDay()` is run to display a message to th The user is also shown the receded day number. ### List Ingredients -![List Ingredient Execution](images/sequence/ListIngredientCommand_execute.png) +![List Ingredient Execution](images/sequence/ListIngredientCommand_execute.svg)
*Figure 17: Execution of `list_ingredient` Command Sequence Diagram* API: [ListIngredientCommand.java](https://github.com/AY2324S1-CS2113-T17-2/tp/blob/master/src/main/java/seedu/cafectrl/command/ListIngredientCommand.java) @@ -274,7 +274,7 @@ Although it may seem tedious the steps are essentially as listed below: - The `Ui` class showcases the information to the user through the `formatListIngredient()` method. ### List Sale By Day -![List_Sale Execution](images/sequence/ShowSaleByDayCommand_execute.png) +![List_Sale Execution](images/sequence/ListSaleByDayCommand_execute.svg)
*Figure 18: Execution of `list_sale` Command Sequence Diagram* API: [ListSaleByDayCommand.java](https://github.com/AY2324S1-CS2113-T17-2/tp/blob/master/src/main/java/seedu/cafectrl/command/ListSaleByDayCommand.java) @@ -293,7 +293,7 @@ The steps are essentially as listed below: * The List Total Sales command follows a comparable sequence, and as such, it will be excluded to avoid the repetition of multiple similar diagrams. ### Pantry - isDishCooked() -![isDishCooked_function](images/sequence/Pantry_IsDishCooked.png) +![isDishCooked_function](images/sequence/Pantry_IsDishCooked.svg)
*Figure 19: Data Processing of `isDishCooked()` Function Used in `add_order` Command Sequence Diagram* API: [Pantry.java](https://github.com/AY2324S1-CS2113-T17-2/tp/blob/master/src/main/java/seedu/cafectrl/data/Pantry.java) @@ -309,7 +309,7 @@ The steps are essentially as listed below: - A `false` indicates that the order was unsuccessful while a `true` indicates that the order was successful. ### Pantry - calculateMaxDish() -![calculateMaxDish_function](images/sequence/Pantry_CalculateMaxDish.png) +![calculateMaxDish_function](images/sequence/Pantry_CalculateMaxDish.svg)
*Figure 20: Data Processing of `calculateMaxDish()` Function Used in `add_order` Command Sequence Diagram* API: [Pantry.java](https://github.com/AY2324S1-CS2113-T17-2/tp/blob/master/src/main/java/seedu/cafectrl/data/Pantry.java) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index d56a4f7cd8..239a478caa 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -327,31 +327,28 @@ Example: `list_total_sales` Output: - list_total_sales lists the dishes sold along with the total sales for every operating day of the cafe. +- in this case, the cafe has operated for two days. ``` +---------------------------------------------------------------------------+ -Day 1: -+---------------------------------------------------------------------------+ | Day 1: | +----------------------------------------+--------------+-------------------+ | Dish Name | Dish Qty | Total Cost Price | +----------------------------------------+--------------+-------------------+ -| chicken chop | 3 | 6.00 | -| chicken sandwhich | 7 | 21.00 | +| Chicken Rice | 2 | 5.00 | +| Chicken Nuggets | 4 | 6.00 | +---------------------------------------------------------------------------+ -| Total for day: | $27.00 | +| Total for day: | $11.00 | +---------------------------------------------------------------------------+ -Day 2: +---------------------------------------------------------------------------+ | Day 2: | +----------------------------------------+--------------+-------------------+ | Dish Name | Dish Qty | Total Cost Price | +----------------------------------------+--------------+-------------------+ -| chicken chop | 2 | 4.00 | -| chicken sandwhich | 2 | 6.00 | -| chicken noodles | 1 | 2.00 | +| Chicken Rice | 2 | 5.00 | +| Chicken Nuggets | 3 | 4.50 | +---------------------------------------------------------------------------+ -| Total for day: | $12.00 | +| Total for day: | $9.50 | +---------------------------------------------------------------------------+ ``` diff --git a/docs/images/aboutUs/naychimin.png b/docs/images/aboutUs/naychimin.png new file mode 100644 index 0000000000..5a48a58427 Binary files /dev/null and b/docs/images/aboutUs/naychimin.png differ diff --git a/docs/images/sequence/ListIngredientCommand_execute.png b/docs/images/sequence/ListIngredientCommand_execute.png deleted file mode 100644 index 2728acb32c..0000000000 Binary files a/docs/images/sequence/ListIngredientCommand_execute.png and /dev/null differ diff --git a/docs/images/sequence/ListIngredientCommand_execute.svg b/docs/images/sequence/ListIngredientCommand_execute.svg new file mode 100644 index 0000000000..0da1de38d6 --- /dev/null +++ b/docs/images/sequence/ListIngredientCommand_execute.svg @@ -0,0 +1 @@ +:ListIngredientCommand:ListIngredientCommand:Menu:Menu:Ui:Ui:Dish:Dish:Ingredients:Ingredients1execute()2getMenuItemsList()3selectedDish : ":Dish"4showListIngredientsMessage(selectedDish: Dish)5showDishName(dish: Dish)6dish.getName()7: String8 9showIngredientList(dish : Dish)10selectedDish.getIngredients()11ingredients: ArrayList<Ingredient>loop[ingredients]12ingredient.getName()13String14ingredient.getQty()15int16ingredient.getUnit()17String18formatListIngredient(ingredientName: String, ingredientAmount: String)19 20showIngredientsEndCap()21 22 23  \ No newline at end of file diff --git a/docs/images/sequence/ListSaleByDayCommand_execute.svg b/docs/images/sequence/ListSaleByDayCommand_execute.svg new file mode 100644 index 0000000000..8b23c9636d --- /dev/null +++ b/docs/images/sequence/ListSaleByDayCommand_execute.svg @@ -0,0 +1 @@ +:ListSaleByDayCommand:ListSaleByDayCommand:Sales:Sales:OrderList:OrderList:Ui:Ui:Order1execute()2sales.printSaleByDay(ui: ":Ui", menu: Menu, day: int)3orderList.hasCompleteOrders()4:booleanalt[no complete order || no orders]5showToUser(message: String)6 7 8 9showSalesTop()10 11orderList.printOrderList()loop[order]12aggregateOrders()13 loop[aggregatedOrder]14 :Order15aggregatedOrder: ":Order"16aggregatedOrder.getDishName()17:String18aggregatedOrder.getQty()19:String20aggregatedOrder.getTotalOrderCost()21:float22showSalesAll(dishName: String, dishQty: int, dishPrice: String)23formatShowSales(dishName: String, dishQty: int, dishPrice: String)24 25 26showSalesBottom()27 28showSalesCost()29 30showSalesBottom()31 32 33 34  \ No newline at end of file diff --git a/docs/images/sequence/Pantry_CalculateMaxDish.png b/docs/images/sequence/Pantry_CalculateMaxDish.png deleted file mode 100644 index d42f54d0b4..0000000000 Binary files a/docs/images/sequence/Pantry_CalculateMaxDish.png and /dev/null differ diff --git a/docs/images/sequence/Pantry_CalculateMaxDish.svg b/docs/images/sequence/Pantry_CalculateMaxDish.svg new file mode 100644 index 0000000000..884067b51f --- /dev/null +++ b/docs/images/sequence/Pantry_CalculateMaxDish.svg @@ -0,0 +1 @@ +:Pantry:Pantry:Dish:Dish:Ingredient1calculateMaxDish(dish: ":Dish", menu: Menu, order: Order)2dish.getName()3dishName:String4retrieveIngredientsForDish(dishName: String)5dishIngredients: ArrayList<":Ingredient">6 :Ingredient7dishIngredient: ":Ingredient"8calculateMaxDishForEachIngredient(dishIngredient: Ingredient)9numOfDish: intalt[!order.getIsComplete()]10handleIncompleteDishCase(dishIngredient: Ingredient), order: Order, numOfDish: int)alt[lacking ingredients (numOfDish < orderQty)]11handleRestock(dishIngredient: ":Ingredient", orderQty: int)12 13 [order.getIsComplete()]14handleZeroDishCase(dishIngredient: Ingredient), order: Order, numOfDish: int)alt[lacking ingredients (numOfDish == 0)]15handleRestock(dishIngredient: ":Ingredient", orderQty: int)16 17 18maxNumOfDish: int \ No newline at end of file diff --git a/docs/images/sequence/Pantry_IsDishCooked.png b/docs/images/sequence/Pantry_IsDishCooked.png deleted file mode 100644 index 4d94e86a61..0000000000 Binary files a/docs/images/sequence/Pantry_IsDishCooked.png and /dev/null differ diff --git a/docs/images/sequence/Pantry_IsDishCooked.svg b/docs/images/sequence/Pantry_IsDishCooked.svg new file mode 100644 index 0000000000..9f7da4b2eb --- /dev/null +++ b/docs/images/sequence/Pantry_IsDishCooked.svg @@ -0,0 +1 @@ +:Pantry:Pantry:Ingredient1isDishCooked(dishIngredients: ArrayList<Ingredient>)loop[dishIngredients]2 :Ingredient3ingredient: ":Ingredient"4getQty()5usedQty: int6getIngredient(dishIngredient: Ingredient))7:":Ingredient"8 :Ingredient9usedIngredientFromStock: ":Ingredient"alt[usedIngredientFromStock == null]10:boolean11getQty()12stockQty: intalt[not enough ":Ingredient" (stockQty-usedQty<0)]13:boolean14setQty(quantity: int)15 16:boolean \ No newline at end of file diff --git a/docs/images/sequence/ShowSaleByDayCommand_execute.png b/docs/images/sequence/ShowSaleByDayCommand_execute.png deleted file mode 100644 index a5aea8b82e..0000000000 Binary files a/docs/images/sequence/ShowSaleByDayCommand_execute.png and /dev/null differ