Merge pull request #432 from sheexiong/master

done

Author: sheexiong

docs/DeveloperGuide.pdf

@@ -46,7 +46,7 @@ Interested? Jump to <<Getting Started>> to get started. Let's go!
 Hope you have a pleasant experience using EYLAH!
 
 .Launch screen of EYLAH
-image::Ui.png[width="790"]
+image::Ui.png[width="890"]
 //end::intro[]
 
 === Purpose
@@ -95,9 +95,9 @@ website.
 Need help setting up EYLAH? Simply follow the steps below to get started in no time!
 
 .  Ensure you have `Java 11` or above installed in your Computer.
-.  Download the latest `eylah.jar` link:{repoURL}/releases[here].
+.  Download the latest `EYLAH.jar` link:{repoURL}/releases[here].
 .  Copy the file to the folder you want to use as the home folder for EYLAH.
-.  Navigate to the folder in terminal and to run the jar file type `java -jar eylah.jar`.
+.  Navigate to the folder in terminal and to run the jar file type `java -jar EYLAH.jar`.
 +
 
 +
@@ -195,15 +195,18 @@ Valid Example: +
 
 *Main Menu:*
 
-image::main_help.png[width="890", height="200"]
+.Main Menu Help
+image::main_help.png[width="890"]
 
 *Diet Tracker Mode:*
 
-image::diethelp.png[width="890", height="200"]
+.Diet Tracker Help
+image::diethelp.png[width="890"]
 
 *Expense Splitter Mode:*
 
-image::splithelp.png[width="890", height="200"]
+.Expense Splitter Help
+image::splithelp.png[width="890"]
 
 *Additional notes and tips* +
 
@@ -262,7 +265,8 @@ You must only input *EXACTLY ONE* mode per mode command.
 [[modeexpectedoutcome]]
 *Expected outcome:*
 
-image::dietTrackerModeCommandSuccessPhoto.png[width="890", height="200"]
+.Diet Tracker Mode Command
+image::dietTrackerModeCommandSuccessPhoto.png[width="890"]
 
 *Additional notes and tips* +
 
@@ -303,7 +307,8 @@ Valid Example: +
 [[heightexpectedoutcome]]
 *Expected outcome:*
 
-image::dietTrackerHeightCommandSuccessPhoto.png[width="890", height="200"]
+.Diet Tracker Height Command
+image::dietTrackerHeightCommandSuccessPhoto.png[width="890"]
 
 *Additional notes and tips* +
 
@@ -342,7 +347,8 @@ Valid Example: +
 [[weightexpectedoutcome]]
 *Expected outcome:*
 
-image::dietTrackerWeightCommandSuccessPhoto.png[width="890", height="200"]
+.Diet Tracker Weight Command
+image::dietTrackerWeightCommandSuccessPhoto.png[width="890"]
 
 *Additional notes and tips* +
 
@@ -388,7 +394,8 @@ Valid Example: +
 [[metricsexpectedoutcome]]
 *Expected outcome:*
 
-image::dietTrackerMetricsCommandSuccessPhoto.png[width="890", height="200"]
+.Diet Tracker Metrics Command
+image::dietTrackerMetricsCommandSuccessPhoto.png[width="890"]
 
 *Additional notes and tips* +
 
@@ -453,7 +460,8 @@ Calculate BMI based on the input height and weight values.
 [[bmiexpectedoutcome]]
 *Expected outcome:*
 
-image::dietTrackerBmiCommandSuccessPhoto.png[width="890", height="200"]
+.Diet Tracker Bmi Command
+image::dietTrackerBmiCommandSuccessPhoto.png[width="890"]
 
 *Additional tips* +
 
@@ -488,7 +496,8 @@ Valid Example: +
 [[addexpectedoutcome]]
 *Expected outcome:*
 
-image::dietTrackerAddCommandSuccessPhoto.png[width="890", height="200"]
+.Diet Tracker Add Command
+image::dietTrackerAddCommandSuccessPhoto.png[width="890"]
 
 *Additional notes* +
 
@@ -538,7 +547,8 @@ Valid Examples: +
 [[listexpectedoutcome]]
 *Expected outcome:*
 
-image::dietTrackerListCommandSuccessPhoto.png[width="890", height="200"]
+.Diet Tracker List Command
+image::dietTrackerListCommandSuccessPhoto.png[width="890"]
 
 *Additional notes* +
 
@@ -586,7 +596,8 @@ correct index of the item.
 [[deleteexpectedoutcome]]
 *Expected outcome:*
 
-image::dietTrackerDeleteCommandSuccessPhoto.png[width="890", height="200"]
+.Diet Tracker Delete Command
+image::dietTrackerDeleteCommandSuccessPhoto.png[width="890"]
 
 *Additional notes and tips* +
 
@@ -634,7 +645,8 @@ correct index of the item.
 [[editexpectedoutcome]]
 *Expected outcome:*
 
-image::dietTrackerEditCommandSuccessPhoto.png[width="890", height="200"]
+.Diet Tracker Edit Command
+image::dietTrackerEditCommandSuccessPhoto.png[width="890"]
 
 *Additional notes and tips* +
 [TIP]
@@ -667,7 +679,8 @@ Valid Example: +
 [[dietbackexpectedoutcome]]
 *Expected outcome:*
 
-image::dietTrackerBackCommandSuccessPhoto.png[]
+.Diet Tracker Back Command
+image::dietTrackerBackCommandSuccessPhoto.png[width="890"]
 //end::diettrackerback[]
 
 '''
@@ -717,7 +730,8 @@ Valid Example: +
 [[additemexpectedoutcome]]
 *Expected outcome:*
 
-image::expensesplitteradditemexpectedoutcome.png[][width="890", height="200"]
+.Expense Splitter Add Item Command
+image::expensesplitteradditemexpectedoutcome.png[width="890"]
 
 [NOTE]
 ====
@@ -751,7 +765,8 @@ Valid Example: +
 [[deleteitemexpectedoutcome]]
 *Expected outcome:*
 
-image::expensesplitterdeleteitemexpectedoutcome.png[][width="890", height="200"]
+.Expense Splitter Delete Item Command
+image::expensesplitterdeleteitemexpectedoutcome.png[width="890"]
 
 [TIP]
 Use `listreceipt` to view your item indices before deletion.
@@ -780,7 +795,8 @@ Valid Example: +
 [[listreceiptexpectedoutcome]]
 *Expected outcome:*
 
-image::listreceipt.png[width="890", height="200"]
+.Expense Splitter List Receipt Command
+image::listreceipt.png[width="890"]
 
 *Additional notes and tips* +
 
@@ -818,7 +834,8 @@ Valid example: +
 [[listamountexpectedoutcome]]
 *Expected outcome:*
 
-image::listamount.png[width="890", height="200"]
+.Expense Splitter List Amount Command
+image::listamount.png[width="890"]
 
 *Additional notes and tips* +
 
@@ -857,7 +874,8 @@ Example: +
 [[donereceiptexpectedoutcome]]
 *Expected outcome:*
 
-image::donereceipt.png[width="890", height="200"]
+.Expense Splitter Done Receipt Command
+image::donereceipt.png[width="890"]
 
 [NOTE]
 ====
@@ -907,7 +925,8 @@ Valid examples: +
 [[paidcommandexpectedoutcome]]
 *Expected outcome:*
 
-image::paid.png[width="890", height="200"]
+.Expense Splitter Paid Command
+image::paid.png[width="890"]
 
 *Additional notes and tips*
 
@@ -945,7 +964,8 @@ Valid Example: +
 [[clearreceiptexpectedoutcome]]
 *Expected outcome:*
 
-image::expensesplitterclearreceiptexpectedoutcome.png[][width="890", height="200"]
+.Expense Splitter Clear Receipt Command
+image::expensesplitterclearreceiptexpectedoutcome.png[width="890"]
 
 [WARNING]
 ====
@@ -985,7 +1005,8 @@ Valid Example: +
 [[splitbackexpectedoutcome]]
 *Expected outcome:*
 
-image::expenseback.png[width="890", height="200"]
+.Expense Splitter Back Command
+image::expenseback.png[width="890"]
 //end::splitback[]
 
 '''
@@ -1012,7 +1033,8 @@ Valid Example: +
 [[exitexpectedoutcome]]
 *Expected outcome:*
 
-image::exit.png[width="890", height="200"]
+.Exit Command
+image::exit.png[width="890"]
 //end::exit[]
 
 '''
@@ -1036,7 +1058,9 @@ example.
 If you would like to know more about a specific command, simply click on the provided links in the table below and you
 will be brought to the respective command.
 //tag::commandsummaryfordiettracker[]
+
 === For Diet Tracker
+.Summary of Command for Diet Tracker
 |===
 |Command |Format |Example
 
@@ -1114,6 +1138,8 @@ or
 //end::commandsummaryfordiettracker[]
 //tag::commandsummaryforexpensesplitter[]
 === For Expense Splitter
+
+.Summary of Command for Expense Splitter
 |===
 |Command |Format |Example
 
@@ -1170,6 +1196,8 @@ or +
 
 [[glossary]]
 == Glossary
+
+.Glossary
 [width="%",cols="<20%,<40,<40,options="header",]
 |=======================================================================
 |Term | Explanation | Examples
@@ -1201,14 +1229,14 @@ The fully blackened circle at the top represents the start point while the circl
 at the bottom represents the end point.
 
 .Expense Splitter Activity Diagram
-image::ExpenseSplitterActivityDiagramV2.png[width="790"]
+image::ExpenseSplitterActivityDiagramV2.png[width="890"]
 
 *Simplified Add Item Activity Diagram*  +
 
 This diagram below is used in conjunction with the diagram directly above this.
 
 .Simplified Add Item Activity Diagram
-image::ExpenseSplitterActivityDiagram.png[width="790"]
+image::ExpenseSplitterActivityDiagram.png[width="890"]
 
 
 

docs/UserGuide.adoc

@@ -39,7 +39,7 @@ My groupmate Akhil, who helped with the correction for some of the bugs in the i
 (https://github.com/AY1920S2-CS2103T-W13-1/main/pull/135#discussion_r393328371[#Github Discussion])
 
 *** *What it does:* +
-Allows the integration of the both Diet Tracker and Expense Splitter seamlessly in the unified EYLAH class.
+_Allows_ the integration of the both Diet Tracker and Expense Splitter seamlessly in the unified EYLAH class.
 
 *** *Highlights:* +
 I noticed this in my review of my team mate, Shee Xiong's, initial reorganisation of the code to allow for unification of both components. Upon further research, Java does not support **class name aliasing**.

docs/team/jarrod-bob.adoc

@@ -1,7 +1,6 @@
 = Chen Shee Xiong - Project Portfolio
 :site-section: AboutUs
 :imagesDir: ../images
-:imagesDir: ../images/expense-splitter
 :stylesDir: ../stylesheets
 
 == PROJECT: EYLAH
@@ -25,9 +24,7 @@ https://github.com/AY1920S2-CS2103T-W13-1/main/pull/367[#367])
 *** *What it does:* +
 Ensure both of the features integrated in the main application.
 *** *Justification:* +
-There are a lot of duplicate code in both features due to the initial plan of splitting team into 2 different group and each group work on their own features.
-Both group follow existing `AddressBook Level-3` code and thus create a lot of duplicate class with exact same code.
-The integration process will help to generalise the duplicate code to common code which can reduce the duplicate code in the whole application.
+The integration can help to reduce the duplicate code in the `EYLAH` which cased by the features done by different sub group.
 *** *Highlights:* +
 During the implementation, I faced a lot of difficulty as we working on the existing `AddressBook Level-3`, the code base given does not show how to integrate 2 different features.
 I have decided to modify some common use class to generic version in order can be implemented by both features.
@@ -50,41 +47,6 @@ item and person involved.
 *** *Credits:* +
 N.A.
 
-. Create main entry class of the application `Elyah.java`, which use to initialise the required components and handle the overall operations of the application.
-(Pull request https://github.com/AY1920S2-CS2103T-W13-1/main/pull/232[#232], https://github.com/AY1920S2-CS2103T-W13-1/main/pull/357[#357])
-*** *What it does:* +
-This is the main entry of whole application. It handle the overall operations of the application and
-also initialise the required components such as storage, model, logic and config of the application.
-*** *Justification:* +
-Due to our team decide to create a pure CLI application instead of JavaFX GUI application, I cannot just simply follow the `AddressBook Level-3` code
-structure to create the main entry of the application. The `Eylah.java` is used to replace `Main.java` in `AddressBook Level-3` as the main entry to the application.
-This class also handling all the initialisation of storage, model and logic component.
-*** *Highlights:* +
-The modification from the existing `AddressBook Level-3` code to the new entry point `Eylah.java` required a lot of effort.
-The existing `AddressBook Level-3` code using multiple class to handle the initialisation and operations flow of the application.
-The migration of initialisation code from existing code cost me a lot of effort to handle the dependency issue regarding to GUI component.
-The new operations flow using in the current implementation partially refers to the `AddressBook Level-2` operations flow structure.
-*** *Credits:* +
-Operation flows reference:
-https://github.com/se-edu/addressbook-level2
-
-
-. Create new UI component for the application
-(Pull request https://github.com/AY1920S2-CS2103T-W13-1/main/pull/140[#140], https://github.com/AY1920S2-CS2103T-W13-1/main/pull/380[#380])
-
-*** *What it does:* +
-This is the UI component of the application. It used to handle the getting input and display result to user.
-*** *Justification:* +
-Due to the removing GUI component from existing code, I am required to create a new UI component to handle the user interaction.
-This UI component will handle the every printing statement and input operation of the application.
-*** *Highlights:* +
-The UI component interact with Logic component by handle the `CommandResult`. It will use the `CommandResult#getFeedbackToUser` to get the
-result string and print it to console for user.
-*** *Credits:* +
-N.A.
-
-
-
 * *Minor enhancement*:
 . Create `ExitCommand` and `BackCommand` for the application
 (Pull request https://github.com/AY1920S2-CS2103T-W13-1/main/pull/357[#357])
@@ -100,26 +62,12 @@ The `ExitCommand` in the main menu handle differently as it directly handle by `
 *** *Credits:* +
 N.A.
 
-. Create `HelpCommand` for main menu and Expense Splitter.
-(Pull request https://github.com/AY1920S2-CS2103T-W13-1/main/pull/254[#254], https://github.com/AY1920S2-CS2103T-W13-1/main/pull/380[#380])
-
-*** *What it does:* +
-Allows user to get the available commands when they forget or unsure how to use certain function.
-*** *Justification:* +
-This can help user to clarify the usage of the application. The `HelpCommand` in Diet Tracker has been implemented by my teammate, Jarrod-Bob.
-*** *Highlights:* +
-The `HelpCommand` in different features and main menu will display different information.
-*** *Credits:* +
-N.A.
-
-
 * *Code contributed*:[https://nus-cs2103-ay1920s2.github.io/tp-dashboard/#search=sheexiong&sort=groupTitle&sortWithin=title&since=2020-02-14&timeframe=commit&mergegroup=false&groupSelect=groupByRepos&breakdown=false[Functional code and Test Code]]
 
 * *Other contributions*:
 
 ** Project management:
 *** In charge of project repository management and ensure the weekly task achievement.
-*** Setup auto repository check for repository such as travis, appveyor, coveralls and netlify.
 *** Participated in planning the project timeline for EYLAH.
 
 ** Enhancements to existing features:
@@ -128,10 +76,7 @@ N.A.
 ** Documentation:
 *** Updated Developer Guide for Done Receipt Command (Pull request https://github.com/AY1920S2-CS2103T-W13-1/main/pull/386[#386], https://github.com/AY1920S2-CS2103T-W13-1/main/pull/388[#388])
 *** Updated Developer Guide for whole Design Section (Pull request https://github.com/AY1920S2-CS2103T-W13-1/main/pull/369[#369], https://github.com/AY1920S2-CS2103T-W13-1/main/pull/380[#380])
-*** Updated User Guide for Help Command (Pull request https://github.com/AY1920S2-CS2103T-W13-1/main/pull/380[#380], https://github.com/AY1920S2-CS2103T-W13-1/main/pull/386[#386])
-*** Updated User Guide for Back Command (Pull request https://github.com/AY1920S2-CS2103T-W13-1/main/pull/386[#386])
-*** Updated User Guide for Exit Command (Pull request https://github.com/AY1920S2-CS2103T-W13-1/main/pull/386[#386], https://github.com/AY1920S2-CS2103T-W13-1/main/pull/394[#394])
-*** Updated User Guide for Done Receipt Command (Pull request https://github.com/AY1920S2-CS2103T-W13-1/main/pull/380[#380], https://github.com/AY1920S2-CS2103T-W13-1/main/pull/386[#386])
+*** Updated User Guide for Back, Exit, Help and Done Receipt Command (Pull request https://github.com/AY1920S2-CS2103T-W13-1/main/pull/380[#380], https://github.com/AY1920S2-CS2103T-W13-1/main/pull/386[#386], https://github.com/AY1920S2-CS2103T-W13-1/main/pull/394[#394])
 
 ** Community:
 *** PRs reviewed (with non-trivial review comments): (Pull requests: https://github.com/AY1920S2-CS2103T-W13-1/main/pull/306[#306], https://github.com/AY1920S2-CS2103T-W13-1/main/pull/176[#176], https://github.com/AY1920S2-CS2103T-W13-1/main/pull/177[#177])