diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 4766e00c075..35e8b8da70a 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -15,7 +15,7 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md). ## **Design** -### Architecture +### Architecture (Jing Qian) @@ -57,7 +57,7 @@ The *Sequence Diagram* below shows how the components interact with each other f The sections below give more details of each component. -### UI component +### UI component (Jing Qian) ![Structure of the UI Component](images/UiClassDiagram.png) @@ -73,7 +73,7 @@ The `UI` component, * Executes user commands using the `Logic` component. * Listens for changes to `Model` data so that the UI can be updated with the modified data. -### Logic component +### Logic component (Jing Qian) ![Structure of the Logic Component](images/LogicClassDiagram.png) @@ -86,14 +86,14 @@ The `UI` component, 1. The result of the command execution is encapsulated as a `CommandResult` object which is passed back to the `Ui`. 1. In addition, the `CommandResult` object can also instruct the `Ui` to perform certain actions, such as displaying help to the user. -Given below is the Sequence Diagram for interactions within the `Logic` component for the `execute("delete 1")` API call. +Given below is the Sequence Diagram for interactions within the `Logic` component for the `execute("exercise_delete 1")` API call. ![Interactions Inside the Logic Component for the `delete 1` Command](images/DeleteSequenceDiagram.png) -
:information_source: **Note:** The lifeline for `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram. +
:information_source: **Note:** The lifeline for `ExerciseDeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
-### Model component +### Model component (Jing Qian) ![Structure of the Model Component](images/ModelClassDiagram.png) @@ -114,7 +114,7 @@ The `Model`,
-### Storage component +### Storage component (Jing Qian) ![Structure of the Storage Component](images/StorageClassDiagram.png) @@ -124,7 +124,7 @@ The `Storage` component, * can save `UserPref` objects in json format and read it back. * can save the fitNUS data in json format and read it back. -### Common classes +### Common classes Classes used by multiple components are in the `seedu.addressbook.commons` package. @@ -134,7 +134,7 @@ Classes used by multiple components are in the `seedu.addressbook.commons` packa This section describes some noteworthy details on how certain features are implemented. -### Create routine +### Create routine (Jing Qian) The feature to create a routine in fitNUS is implemented using `RoutineCreateCommand` class, which inherits from `Command` class. The argument is supplied after parsing the user input by the `RoutineCreateCommandParser` class. @@ -174,7 +174,7 @@ Given below is the sequence diagram showing how the routine creation command is ![Routine Create](./images/RoutineAddSequenceDiagram.png) -### Add Routine to Timetable +### Add Routine to Timetable (Nicholas) The `TimetableAddRoutineCommandParser` and `TimetableAddRoutineCommand` classes parse and execute the user input to add a routine to the timetable in fitNUS. @@ -221,7 +221,7 @@ execute("timetable_add_routine r/Leg Workout d/Monday T/1600-1700") API call. ![TimetableAddRoutineSequenceDiagram](images/TimetableAddRoutineSequenceDiagram.png) -### Find exercises +### Find exercises (Licheng) The find exercises feature is implemented using `FindExercisesCommandParser`, as well as the following command: * `FindExercisesCommand`, to be executed when the user inputs the command into fitNUS. @@ -268,7 +268,7 @@ API call. ![FindExercisesSequenceDiagram](images/FindExercisesSequenceDiagram.png) -### Delete lesson +### Delete lesson (Iqbal) The delete lesson feature is implemented using `LessonDeleteCommandParser`, as well as the following command: * `LessonDeleteCommand`, to be executed when the user inputs the command into fitNUS. @@ -339,7 +339,7 @@ The GUI then lists the deleted lesson. around their classes. -### User stories +### User stories (Jing QIan) Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*` @@ -352,7 +352,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli | `* * *` | health-conscious individual | log my BMI | keep better track of my health. -### Use cases +### Use cases (Licheng) (For all use cases below, the **System** is the `fitNUS` and the **Actor** is the `user`, unless specified otherwise) @@ -597,7 +597,7 @@ testers are expected to do more *exploratory* testing. 1. _{ more test cases …​ }_ -### Deleting a Routine +### Deleting a Routine (Jing Qian) 1. Deleting a Routine diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 8f09bd02ed7..ca102460eef 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -8,7 +8,7 @@ title: User Guide {:toc} ------------------------------------------------------------------------------------------------------------------------ -## 1. Introduction +## 1. Introduction (Licheng) fitNUS is tailored for **NUS students** that are interested in staying healthy and keeping fit. It is suitable for **all fitness levels** and is equipped with a **customisable timetable** for you to manage your time wisely and slot in your @@ -48,7 +48,7 @@ Note how the app contains some sample data.
-------------------------------------------------------------------------------------------------------------------- ## 3. Features -### 3.1 Exercise +### 3.1 Exercise (Licheng) #### 3.1.1 Create new exercise : `exercise_add` @@ -92,7 +92,7 @@ Example: ![Find Exercises](./images/find_exercises.png); -### 3.2 Routine +### 3.2 Routine (Jing Qian) #### 3.2.1 Create new routine : `routine_create` @@ -181,7 +181,7 @@ Example: ![Find Routines Result](./images/routine_find_after.png) -### 3.3 Lesson +### 3.3 Lesson (Nicholas) #### 3.3.1 Create new lesson : `lesson_add` @@ -269,9 +269,6 @@ Deletes the routine or lesson scheduled on Monday, 1600-1800. ![Timetable Delete](./images/timetable_delete.png) -### BMI - -#### Add or edit height : `height` #### 3.4.4 View timetable : `timetable_view` @@ -282,7 +279,7 @@ Format: `timetable_view` Examples: * `timetable view` Views timetable. -### 3.5 BMI +### 3.5 BMI (Jing Qian) #### 3.5.1 Add or edit height : `height` @@ -315,7 +312,7 @@ Format: `bmi` Examples: * `bmi` Views BMI. -### 3.6 Miscellaneous +### 3.6 Miscellaneous (Jing Qian) #### 3.6.1 Help: `help` @@ -343,7 +340,7 @@ _{explain the feature here}_ -------------------------------------------------------------------------------------------------------------------- -## 4. Command summary +## 4. Command summary (Nicholas) ### 4.1 Miscellaneous