Merge pull request #175 from Benson15912/branch-updateDG

Update DG
AY2324S2-CS2103T-F10-4 · Apr 14, 2024 · 231779f · 231779f
2 parents aa3f0c8 + 83436d9
commit 231779f
Show file tree

Hide file tree

Showing 11 changed files with 653 additions and 159 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/diagrams/AssignActivityDiagram.puml b/docs/diagrams/AssignActivityDiagram.puml
@@ -0,0 +1,32 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+start
+:User assigns a volunteer;
+:Parse arguments;
+if () then ([Invalid arguments])
+    #red:Shows error message;
+else ([Valid Arguments])
+:Check whether volunteer is available on that day;
+if () then ([Volunteer not available])
+    #red:Shows error message;
+
+else ([Volunteer available])
+:Check whether volunteer already has an assignment on that day;
+if () then ([Already has an assignment])
+    #red:Shows error message;
+
+else ([No assignments])
+:Check for duplicate assignments;
+if () then ([Duplicate assignments])
+    #red:Shows error message;
+
+else ([No duplicate assignments])
+    #green:Create assignment and add;
+endif
+endif
+endif
+endif
+stop
+@enduml
diff --git a/docs/diagrams/AssignmentClassDiagram.puml b/docs/diagrams/AssignmentClassDiagram.puml
@@ -0,0 +1,17 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor MODEL_COLOR
+skinparam classBackgroundColor MODEL_COLOR
+
+Package Assignment as ModelPackage <<Rectangle>>{
+Class Person
+Class Availability
+Class Assignment
+Class AssignmentDetails
+Class I #FFFFFF
+}
+Assignment *--> "1" Person
+Assignment *--> "1" AssignmentDetails
+Assignment *--> "1" Availability
+@enduml
diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml
@@ -14,15 +14,11 @@ Class UserPrefs
 
 Class UniquePersonList
 Class Person
-Class Email
-Class Name
-Class Phone
-Class Availability
-Class Tag
+
 
 Class AssignmentList
 Class Assignment
-Class AssignmentDetails
+
 
 Class I #FFFFFF
 }
@@ -35,30 +31,23 @@ AddressBook .up.|> ReadOnlyAddressBook
 ModelManager .up.|> Model
 Model .right.> ReadOnlyUserPrefs
 Model .left.> ReadOnlyAddressBook
-ModelManager -left-> "1" AddressBook
+ModelManager -down-> "1" AddressBook
 ModelManager -right-> "1" UserPrefs
 UserPrefs .up.|> ReadOnlyUserPrefs
 
-AddressBook *--> "1" UniquePersonList
-AddressBook *--> "1" AssignmentList
-UniquePersonList --> "*" Person
-Person *--> Name
-Person *--> Phone
-Person *--> Email
-Person *--> "*" Availability
-Person *--> "*" Tag
+AddressBook *-down-> "1" UniquePersonList
+AddressBook *-down-> "1" AssignmentList
+UniquePersonList -down--> "*" Person
 
-AssignmentList *--> "*" Assignment
-Assignment *--> "1"Person
-Assignment *--> "1" AssignmentDetails
-Assignment *--> "1" Availability
+
+AssignmentList -down--> "*" Assignment
+Assignment -left--> "1"Person
 
 Person -[hidden]up--> I
 UniquePersonList -[hidden]right-> I
 
-Name -[hidden]right-> Phone
-Phone -[hidden]right-> Email
-Email -[hidden]right-> Availability
+
 
 ModelManager --> "~* filtered" Person
+ModelManager --> "~* filtered" Assignment
 @enduml
diff --git a/docs/diagrams/PersonClassDiagram.puml b/docs/diagrams/PersonClassDiagram.puml
@@ -0,0 +1,25 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor MODEL_COLOR
+skinparam classBackgroundColor MODEL_COLOR
+
+Package Person as ModelPackage <<Rectangle>>{
+Class Person
+Class Email
+Class Name
+Class Phone
+Class Availability
+Class Tag
+Class I #FFFFFF
+}
+
+Person *--> "1"Name
+Person *--> "1"Phone
+Person *--> "1"Email
+Person *--> "*" Availability
+Person *--> "*" Tag
+Name -[hidden]right-> Phone
+Phone -[hidden]right-> Email
+Email -[hidden]right-> Availability
+@enduml
diff --git a/docs/images/AssignActivityDiagram.png b/docs/images/AssignActivityDiagram.png
diff --git a/docs/images/AssignmentClassDiagram.png b/docs/images/AssignmentClassDiagram.png
diff --git a/docs/images/ModelClassDiagram.png b/docs/images/ModelClassDiagram.png
diff --git a/docs/images/PersonClassDiagram.png b/docs/images/PersonClassDiagram.png
diff --git a/src/main/java/seedu/address/logic/commands/CommandResult.java b/src/main/java/seedu/address/logic/commands/CommandResult.java
@@ -23,7 +23,7 @@ public class CommandResult {
     private final boolean exit;
 
     /** Application List Panel Selection */
-
+    // ListPanelView to switch views is inspired by https://github.com/AY2324S1-CS2103T-W08-4/tp
     public enum ListPanelView {
         NO_EFFECT,
         PERSON,

diff --git a/src/main/java/seedu/address/ui/MainWindow.java b/src/main/java/seedu/address/ui/MainWindow.java
@@ -140,6 +140,9 @@ private void setWindowDefaultSize(GuiSettings guiSettings) {
         }
     }
 
+    //@@author Benson15912 - reused and modified
+    //Reused from https://github.com/AY2324S1-CS2103T-W08-4/tp
+    // with minor modifications
     /**
      * Sets the display of the panel between Assignments and Person
      * @param display
@@ -159,6 +162,7 @@ private void handleListPanel(CommandResult.ListPanelView display) {
         }
     }
 
+    //@@author
     /**
      * Opens the help window or focuses on it if it's already opened.
      */