Merge pull request #229 from jianrong7/chore/dg

Chore/dg
AY2324S1-CS2103T-W11-2 · Nov 12, 2023 · e7b75c3 · e7b75c3
2 parents 2051f7d + 8ebcb00
commit e7b75c3
Show file tree

Hide file tree

Showing 15 changed files with 479 additions and 97 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -43,7 +43,7 @@ As property agents, we understand that using a [Command Line Interface (CLI)](ht
 Already familiar with using a CLI? Great! Feel free to move on to the section below to begin your PropertyMatch journey!
 
 * Embark on your PropertyMatch journey using our [Quick Start](#quick-start) Guide - the express lane to get PropertyMatch up and running in no time!
-* Afterwhich, you can head over to our [Interface Layout](#interface-layout) section to familiarise yourself with our snazzy interface and discover the ins and outs of the [CLI](#2-command-input-and-output-boxes). 
+* Afterwhich, you can head over to our [Interface Layout](#interface-layout) section to familiarise yourself with our snazzy interface and discover the ins and outs of the [CLI](#2-command-input-and-output-boxes).
 * Take a look at the [Command Summary](#command-summary) - your cheatsheet for the different commands along with links to how to use them
 
 Let the fun begin – because who said setting up can't be a joyride?

diff --git a/docs/diagrams/AddCustomerActivityDiagram.puml b/docs/diagrams/AddCustomerActivityDiagram.puml
@@ -0,0 +1,23 @@
+@startuml
+start
+:User executes add customer command;
+
+'Since the beta syntax does not support placing the condition outside the
+'diamond we place it as the true branch instead.
+
+if () then ([User provided all required parameters])
+:Customer's name, budget, phone number, email are parsed;
+if () then ([characteristics provided])
+:Customer's characteristics is parsed;
+note left
+    For a customer, only its
+    characteristics are optional.
+end note
+else([else])
+endif
+#palegreen:New customer is returned;
+stop
+else([User failed to provide required parameters correctly])
+#pink:PropertyMatch displays an error;
+end
+@enduml
diff --git a/docs/diagrams/AddPropertyActivityDiagram.puml b/docs/diagrams/AddPropertyActivityDiagram.puml
@@ -0,0 +1,23 @@
+@startuml
+start
+:User executes add property command;
+
+'Since the beta syntax does not support placing the condition outside the
+'diamond we place it as the true branch instead.
+
+if () then ([User provided all required parameters])
+:Property's name, price, phone number, are parsed;
+if () then ([characteristics provided])
+:Property's characteristics is parsed;
+note left
+    For a property, only its
+    characteristics are optional.
+end note
+else([else])
+endif
+#palegreen:New property is returned;
+stop
+else([User failed to provide required parameters correctly])
+#pink:PropertyMatch displays an error;
+end
+@enduml
diff --git a/docs/diagrams/CustomerObjectDiagram.puml b/docs/diagrams/CustomerObjectDiagram.puml
@@ -0,0 +1,27 @@
+@startuml
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+
+package CustomerObjectDiagram {
+    Object "<u>:Customer" as Customer {
+    }
+
+    Object "<u>:Name" as Name {
+    }
+    Object "<u>:Phone" as Phone {
+    }
+    Object "<u>:Email" as Email {
+    }
+    Object "<u>:Budget" as Budget {
+    }
+    Object "<u>:Tags" as Tags {
+    }
+}
+
+Name <-- Customer : has <
+Phone <-- Customer : has <
+Email <-- Customer : has <
+Budget <-- Customer : has <
+Tags <-- Customer : has <
+
+@enduml
diff --git a/docs/diagrams/EditCustomerSequenceDiagram.puml b/docs/diagrams/EditCustomerSequenceDiagram.puml
@@ -20,7 +20,7 @@ LogicManager -> AddressBookParser : parseCommand("edistcust 1 n/Janet")
 activate AddressBookParser
 
 create EditCustomerCommandParser
-AddressBookParser -> EditCustomerCommandParser : new EditCustomerCommandParser("1 n/Janet")
+AddressBookParser -> EditCustomerCommandParser :
 activate EditCustomerCommandParser
 
 EditCustomerCommandParser --> AddressBookParser
@@ -30,7 +30,7 @@ AddressBookParser -> EditCustomerCommandParser : parse("1 n/Janet")
 activate EditCustomerCommandParser
 
 create EditCustomerCommand
-EditCustomerCommandParser -> EditCustomerCommand : new EditCustomerCommand(1, editCustomerDescriptor)
+EditCustomerCommandParser -> EditCustomerCommand :
 activate EditCustomerCommand
 
 EditCustomerCommand --> EditCustomerCommandParser : command
@@ -58,7 +58,7 @@ EditCustomerCommand -> Model : setCustomer(CustomerToEdit, editedCustomer)
 EditCustomerCommand -> Model : updateFilteredCustomerList(PREDICATE_SHOW_ALL_CUSTOMERS)
 
 create CommandResult
-EditCustomerCommand -> CommandResult : new CommandResult("Edited customer: " + editedCustomer)
+EditCustomerCommand -> CommandResult :
 activate CommandResult
 
 CommandResult --> EditCustomerCommand

diff --git a/docs/diagrams/EditPropertySequenceDiagram.puml b/docs/diagrams/EditPropertySequenceDiagram.puml
@@ -20,7 +20,7 @@ LogicManager -> AddressBookParser : parseCommand("editprop 1 n/Skyview")
 activate AddressBookParser
 
 create EditPropertyCommandParser
-AddressBookParser -> EditPropertyCommandParser : new EditPropertyCommandParser("1 n/Skyview")
+AddressBookParser -> EditPropertyCommandParser :
 activate EditPropertyCommandParser
 
 EditPropertyCommandParser --> AddressBookParser
@@ -30,7 +30,7 @@ AddressBookParser -> EditPropertyCommandParser : parse("1 n/Skyview")
 activate EditPropertyCommandParser
 
 create EditPropertyCommand
-EditPropertyCommandParser -> EditPropertyCommand : new EditPropertyCommand(1, editPropertyDescriptor)
+EditPropertyCommandParser -> EditPropertyCommand :
 activate EditPropertyCommand
 
 EditPropertyCommand --> EditPropertyCommandParser : command
@@ -55,7 +55,7 @@ deactivate EditPropertyCommand
 
 EditPropertyCommand -> Model : setProperty(PropertyToEdit, editedProperty)
 
-EditPropertyCommand -> Model : updateFilteredPropertyList(PREDICATE_SHOW_ALL_PROPERTY)
+EditPropertyCommand -> Model : updateFilteredPropertyList(PREDICATE_SHOW_ALL_PROPERTIES)
 
 create CommandResult
 EditPropertyCommand -> CommandResult : new CommandResult("Edited property: " + editedProperty)

diff --git a/docs/diagrams/PropertyObjectDiagram.puml b/docs/diagrams/PropertyObjectDiagram.puml
@@ -0,0 +1,27 @@
+@startuml
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+
+package PropertyObjectDiagram {
+    Object "<u>:Property" as Property {
+    }
+
+    Object "<u>:PropName" as PropName {
+    }
+    Object "<u>:PropAddress" as PropAddress {
+    }
+    Object "<u>:PropPhone" as PropPhone {
+    }
+    Object "<u>:Price" as Price {
+    }
+    Object "<u>:Tags" as Tags {
+    }
+}
+
+PropName <-- Property : has <
+PropAddress <-- Property : has <
+PropPhone <-- Property : has <
+Price <-- Property : has <
+Tags <-- Property : has <
+
+@enduml
diff --git a/docs/images/AddCustomerActivityDiagram.png b/docs/images/AddCustomerActivityDiagram.png
diff --git a/docs/images/AddPropertyActivityDiagram.png b/docs/images/AddPropertyActivityDiagram.png
diff --git a/docs/images/CustomerObjectDiagram.png b/docs/images/CustomerObjectDiagram.png
diff --git a/docs/images/DeleteSequenceDiagram.png b/docs/images/DeleteSequenceDiagram.png
diff --git a/docs/images/EditCustomerSequenceDiagram.png b/docs/images/EditCustomerSequenceDiagram.png
diff --git a/docs/images/EditPropertySequenceDiagram.png b/docs/images/EditPropertySequenceDiagram.png
diff --git a/docs/images/PropertyObjectDiagram.png b/docs/images/PropertyObjectDiagram.png