nus-cs2103-AY2223S1 · lfrostbytee · Nov 1, 2022 · Nov 1, 2022 · Nov 1, 2022 · Nov 1, 2022
diff --git a/README.md b/README.md
@@ -1,16 +1,20 @@
+# Duke The Market
+
+--------------------------------------------------------------------------------------------------------------------
+
 [![CI Status](https://github.com/AY2223S1-CS2103-F09-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S1-CS2103-F09-2/tp/actions)
 
-### Persons
 ![Ui](docs/images/Ui.png)
 
-### Events
-![Ui_events](docs/images/Ui_events.png)
+## About Duke The Market
 
-# Duke The Market
+--------------------------------------------------------------------------------------------------------------------
 
-Duke The Market is a one-stop marketing tool that allows department stores to keep track of their upcoming marketing plan roll outs, monitor its impact, and to target the appropriate subsegment of its customer base for each of those plans.
+Duke The Market is a one-stop marketing tool that allows department stores to keep track of their upcoming marketing
+plan roll outs, monitor its impact, and to target the appropriate subsegment of its customer base for
+each of those plans.
 
-* If you are keen on using this application, head over to the User Guide [Link TBC]
-* If you are keen on adding new features to this application, head over to the Developer Guide [Link TBC]
+* If you are keen on using this application, head over to the [User Guide](https://ay2223s1-cs2103-f09-2.github.io/tp/UserGuide.html).
+* If you are keen on adding new features to this application, head over to the [Developer Guide](https://ay2223s1-cs2103-f09-2.github.io/tp/DeveloperGuide.html).
 
 This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -5,8 +5,6 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
-
 ## Project team
 
 ### Ong Wee, Marcus

diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -103,7 +103,7 @@ will not run and will output the error message `This person already exists in th
 </div>
 
 <div markdown ="span" class="alert alert-info">
-:information_source: **Note:** The year "0000" is an invalid input for all persons and events.
+:information_source: **Note:** The year "0000" is an invalid input for all persons.
 </div>
 
 ### Listing all persons : `listPersons`
@@ -113,9 +113,9 @@ Shows a list of all persons in the application.
 Format: `listPersons [s/FIELD]`
 
 * Sorts all persons by a specified field. `FIELD` must take one of the following values:
-  * `n` or `N` sort by name in ascending lexicographical order, ignoring case differences
-  * `d` or `D` sort by date of birth from oldest to youngest
-  * `g` or `G` sort by gender, females first followed by males
+  * `n` or `N`: sort by name in ascending lexicographical order, ignoring case differences
+  * `d` or `D`: sort by date of birth from oldest to youngest
+  * `g` or `G`: sort by gender, females first followed by males
 
 * It is optional to include the sorting prefix and field. If the sorting prefix and field are not included, the application will display all persons in the current order that they are stored.
 * At most one field can be specified. i.e. Cannot specify 2nd or 3rd criteria to sort by.
@@ -172,7 +172,7 @@ Format: `findPersons KEYWORD [MORE_KEYWORDS]`
 Examples:
 * `findPersons John` returns `john` and `John Doe`
 * `findPersons alex david` returns `Alex Yeoh`, `David Li`<br>
-  ![result for 'findPersons alex david'](images/findPersonsAlexDavidResult.png)
+
 
 ### Deleting a person : `deletePerson`
 
@@ -216,6 +216,9 @@ will not run and will output the error message `This event already exists in the
 :information_source: **Note:** To add an event with the time of 12am, only input `t/00:00` is allowed. Meanwhile, the input of `t/24:00` is not allowed.
 </div>
 
+<div markdown ="span" class="alert alert-info">
+:information_source: **Note:** The year "0000" is an invalid input for all events.
+</div>
 
 
 ### Editing an event : `editEvent`
@@ -255,7 +258,6 @@ Format: `findEvents KEYWORD [MORE_KEYWORDS]`
 Examples:
 * `findEvents Sale` returns `sale` and `Marketing Sale`
 * `findEvents sports car` returns `Sports Festival`, `Car Sale`<br>
-  ![result for 'findEvents Sports Car'](images/findEventsSportsCar.png)
 
 
 ### Deleting an event: `deleteEvent`
@@ -279,8 +281,8 @@ Shows a list of all events in the application.
 Format: `listEvents [s/FIELD]`
 
 * Sorts the events by a specified field. `FIELD` must take one of the following values:
-  * `e` or `E` sort by event title in ascending lexicographical order, ignoring case differences
-  * `d` or `D` sort by date from oldest to newest
+  * `e` or `E`: sort by event title in ascending lexicographical order, ignoring case differences
+  * `d` or `D`: sort by date from oldest to newest
 
 * It is optional to include the sorting prefix and field. If the sorting prefix and field are not included, the application will display all events in the current order that they are stored.
 * At most one field can be specified. i.e. Cannot specify 2nd or 3rd criteria to sort by.
@@ -353,8 +355,8 @@ Format: `makeStats EVENT_INDEX t/STATISTIC_TYPE`
 * The `EVENT_INDEX` refers to the index number shown in the displayed event list.
 * The `EVENT_INDEX` must be **a positive integer** 1, 2, 3, …, and it must be within the range of the event list index. This command is invalid if `EVENT_INDEX` is a non-positive integer.
 * The `STATISTIC_TYPE` refers to the type of statistical data being generated and it must take one of the following values:
-  * `a` generate a pie chart showing the distribution of ages across age groups
-  * `g` generate a pie chart showing the distribution of genders
+  * `a` generate a pie chart showing the distribution of ages across age groups. Each age group has a 5-year age range.
+  * `g` generate a pie chart showing the distribution of genders, separating them into either `Male` or `Female` categories.
 
 Example:
 * `makeStats 1 t/g` generates gender statistics of the persons tagged to the 1st event in the event list

diff --git a/docs/diagrams/AddPersonDobActivityDiagram.puml b/docs/diagrams/AddPersonDobActivityDiagram.puml
@@ -0,0 +1,19 @@
+@startuml
+start
+repeat
+:User enters add person command;
+if () then ([date of birth field is provided])
+  if () then ([date of birth format is valid])
+    if () then ([person doesn't exist
+   in the contact list])
+      :Person is added with valid date of birth field;
+      stop
+    else ([else])
+    endif
+  else ([else])
+  endif
+else ([else])
+endif
+backward :System shows error message;
+repeat while;
+@enduml
diff --git a/docs/diagrams/AddPersonActivityDiagram.puml → ...grams/AddPersonGenderActivityDiagram.puml b/docs/diagrams/AddPersonActivityDiagram.puml → ...grams/AddPersonGenderActivityDiagram.puml
diff --git a/docs/diagrams/AddPersonSequenceDiagram.puml b/docs/diagrams/AddPersonSequenceDiagram.puml
@@ -5,11 +5,11 @@ box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":AddPersonCommandParser" as AddPersonCommandParser LOGIC_COLOR
-participant "c:AddPersonCommand" as AddPersonCommand LOGIC_COLOR
+participant "a:AddPersonCommand" as AddPersonCommand LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
-participant ":ModelManager" as ModelManager MODEL_COLOR
+participant "b:ModelManager" as ModelManager MODEL_COLOR
 participant ":AddressBook" as AddressBook MODEL_COLOR
 end box
 
@@ -27,16 +27,17 @@ create AddPersonCommand
 AddPersonCommandParser -> AddPersonCommand : parse(cmd)
 activate AddPersonCommand
 
-AddPersonCommand --> AddPersonCommandParser
+AddPersonCommand --> AddPersonCommandParser : a
 deactivate AddPersonCommand
 
-AddPersonCommandParser --> AddressBookParser
+AddPersonCommandParser --> AddressBookParser : a
 deactivate AddPersonCommandParser
 
-AddressBookParser --> LogicManager : c
+AddressBookParser --> LogicManager : a
 deactivate AddressBookParser
+destroy AddPersonCommandParser
 
-LogicManager -> AddPersonCommand : execute()
+LogicManager -> AddPersonCommand : execute(b)
 activate AddPersonCommand
 
 AddPersonCommand -> ModelManager : addPerson(Person)

diff --git a/docs/diagrams/ArchitectureSequenceDiagram.puml b/docs/diagrams/ArchitectureSequenceDiagram.puml
@@ -7,10 +7,10 @@ Participant ":Logic" as logic LOGIC_COLOR
 Participant ":Model" as model MODEL_COLOR
 Participant ":Storage" as storage STORAGE_COLOR
 
-user -[USER_COLOR]> ui : "delete 1"
+user -[USER_COLOR]> ui : "deletePerson 1"
 activate ui UI_COLOR
 
-ui -[UI_COLOR]> logic : execute("delete 1")
+ui -[UI_COLOR]> logic : execute("deletePerson 1")
 activate logic LOGIC_COLOR
 
 logic -[LOGIC_COLOR]> model : deletePerson(p)

diff --git a/docs/diagrams/DeletePersonSequenceDiagram.puml b/docs/diagrams/DeletePersonSequenceDiagram.puml
@@ -0,0 +1,62 @@
+@startuml
+!include style.puml
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":DeletePersonCommandParser" as DeletePersonCommandParser LOGIC_COLOR
+participant "d:DeletePersonCommand" as DeletePersonCommand LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant "b:ModelManager" as ModelManager MODEL_COLOR
+participant ":AddressBook" as AddressBook MODEL_COLOR
+end box
+
+[-> LogicManager : execute(cmd)
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand(cmd)
+activate AddressBookParser
+
+create DeletePersonCommandParser
+AddressBookParser -> DeletePersonCommandParser
+activate DeletePersonCommandParser
+
+create DeletePersonCommand
+DeletePersonCommandParser -> DeletePersonCommand : parse(cmd)
+activate DeletePersonCommand
+
+DeletePersonCommand --> DeletePersonCommandParser : d
+deactivate DeletePersonCommand
+
+DeletePersonCommandParser --> AddressBookParser : d
+deactivate DeletePersonCommandParser
+
+AddressBookParser --> LogicManager : d
+deactivate AddressBookParser
+destroy DeletePersonCommandParser
+
+LogicManager -> DeletePersonCommand : execute(b)
+activate DeletePersonCommand
+
+DeletePersonCommand -> ModelManager : deletePerson(Person)
+activate ModelManager
+
+ModelManager -> AddressBook : removePerson(Person)
+activate AddressBook
+
+AddressBook --> ModelManager :
+deactivate AddressBook
+
+ModelManager --> DeletePersonCommand :
+deactivate ModelManager
+
+DeletePersonCommand --> LogicManager : result
+deactivate DeletePersonCommand
+DeletePersonCommand -[hidden]-> LogicManager : result
+destroy DeletePersonCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/DeleteSequenceDiagram.puml b/docs/diagrams/DeleteSequenceDiagram.puml
diff --git a/docs/diagrams/EditEventSequenceDiagram.puml b/docs/diagrams/EditEventSequenceDiagram.puml
@@ -0,0 +1,68 @@
+@startuml
+!include style.puml
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":EditEventCommandParser" as EditEventCommandParser LOGIC_COLOR
+participant "e:EditEventCommand" as EditEventCommand LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant "b:ModelManager" as ModelManager MODEL_COLOR
+participant ":AddressBook" as AddressBook MODEL_COLOR
+participant ":UniqueEventList" as UniqueEventList MODEL_COLOR
+end box
+
+-> LogicManager : execute(cmd)
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand(cmd)
+activate AddressBookParser
+
+create EditEventCommandParser
+AddressBookParser -> EditEventCommandParser : parse(cmd)
+activate EditEventCommandParser
+
+create EditEventCommand
+EditEventCommandParser -> EditEventCommand
+activate EditEventCommand
+
+EditEventCommand --> EditEventCommandParser : e
+deactivate EditEventCommand
+
+EditEventCommandParser --> AddressBookParser : e
+deactivate EditEventCommandParser
+
+AddressBookParser --> LogicManager : e
+deactivate AddressBookParser
+destroy EditEventCommandParser
+
+LogicManager -> EditEventCommand : execute(b)
+activate EditEventCommand
+
+EditEventCommand -> ModelManager : setEvent(E1, E2)
+activate ModelManager
+
+ModelManager -> AddressBook : setEvent(E1, E2)
+activate AddressBook
+
+AddressBook -> UniqueEventList : setEvent(E1, E2)
+activate UniqueEventList
+
+UniqueEventList --> AddressBook
+deactivate UniqueEventList
+
+AddressBook --> ModelManager
+deactivate AddressBook
+
+ModelManager --> EditEventCommand
+deactivate ModelManager
+
+EditEventCommand --> LogicManager : CommandResult
+deactivate EditEventCommand
+
+<--LogicManager
+deactivate LogicManager
+destroy EditEventCommand
+@enduml
diff --git a/docs/diagrams/EditPersonDobActivityDiagram.puml b/docs/diagrams/EditPersonDobActivityDiagram.puml
@@ -0,0 +1,16 @@
+@startuml
+start
+repeat
+:User enters edit person command;
+  if () then ([date of birth format is valid])
+    if () then ([person already exists
+    in the contact list])
+      :Person is edited with new date of birth field;
+      stop
+    else ([else])
+    endif
+  else ([else])
+  endif
+backward :System shows error message;
+repeat while;
+@enduml
diff --git a/docs/diagrams/EditPersonActivityDiagram.puml → ...rams/EditPersonGenderActivityDiagram.puml b/docs/diagrams/EditPersonActivityDiagram.puml → ...rams/EditPersonGenderActivityDiagram.puml