Merge pull request #157 from Vision-2000/branch-DeveloperGuide-2

Update DG and diagrams
AY2324S2-CS2103T-T14-2 · Apr 15, 2024 · ac5acb6 · ac5acb6
2 parents 2c80c49 + a9064f9
commit ac5acb6
Show file tree

Hide file tree

Showing 11 changed files with 98 additions and 172 deletions.
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -27,7 +27,6 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 <img src="images/vision-2000.png" width="200px">
 
 [[github](http://github.com/Vision-2000)]
-[[portfolio](team/johndoe.md)]
 
 * Role: Developer
 * Responsibilities: Testing + UI + Logic

diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/diagrams/ArchitectureSequenceDiagram.puml b/docs/diagrams/ArchitectureSequenceDiagram.puml
@@ -21,6 +21,7 @@ model -[MODEL_COLOR]-> logic
 deactivate model
 
 logic -[LOGIC_COLOR]> storage : savePatientList(patientList)
+
 activate storage STORAGE_COLOR
 
 storage -[STORAGE_COLOR]> storage : Save to file

diff --git a/docs/diagrams/BetterModelClassDiagram.puml b/docs/diagrams/BetterModelClassDiagram.puml
diff --git a/docs/diagrams/FindSequenceDiagram.puml b/docs/diagrams/FindSequenceDiagram.puml
@@ -49,7 +49,7 @@ deactivate InputParser
 LogicManager -> FindCommand : execute(m)
 activate FindCommand
 
-FindCommand -> Model : updateFilteredPersonList(namePredicate)
+FindCommand -> Model : updateFilteredPatientList(namePredicate)
 activate Model
 
 Model --> FindCommand
@@ -65,6 +65,6 @@ deactivate CommandResult
 FindCommand --> LogicManager : r
 deactivate FindCommand
 
-[<--LogicManager
+[<--LogicManager : r
 deactivate LogicManager
 @enduml
diff --git a/docs/diagrams/ForceDeleteAllSequenceDiagram-Logic.puml b/docs/diagrams/ForceDeleteAllSequenceDiagram-Logic.puml
@@ -4,7 +4,7 @@ skinparam ArrowFontStyle plain
 
 box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
-participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":InputParser" as InputParser LOGIC_COLOR
 participant "f:ForceDeleteAllCommand" as ForceDeleteAllCommand LOGIC_COLOR
 end box
 
@@ -14,23 +14,23 @@ end box
 [-> LogicManager : execute(delete-all-f)
 activate LogicManager
 
-LogicManager -> AddressBookParser : parseCommand(delete-all-f)
-activate AddressBookParser
+LogicManager -> InputParser : parseCommand(delete-all-f)
+activate InputParser
 
 create ForceDeleteAllCommand
-AddressBookParser -> ForceDeleteAllCommand
+InputParser -> ForceDeleteAllCommand
 activate ForceDeleteAllCommand
 
-ForceDeleteAllCommand --> AddressBookParser
+ForceDeleteAllCommand --> InputParser
 deactivate ForceDeleteAllCommand
 
-AddressBookParser --> LogicManager : f
-deactivate AddressBookParser
+InputParser --> LogicManager : f
+deactivate InputParser
 
 LogicManager -> ForceDeleteAllCommand : execute()
 activate ForceDeleteAllCommand
 
-ForceDeleteAllCommand -> Model : setAddressBook()
+ForceDeleteAllCommand -> Model : setPatientList()
 activate Model
 
 Model --> ForceDeleteAllCommand

diff --git a/docs/diagrams/ListSequenceDiagram.puml b/docs/diagrams/ListSequenceDiagram.puml
@@ -4,7 +4,7 @@ skinparam ArrowFontStyle plain
 
 box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
-participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":InputParser" as InputParser LOGIC_COLOR
 participant "f:ListCommand" as ListCommand LOGIC_COLOR
 participant ":CommandResult" as CommandResult LOGIC_COLOR
 end box
@@ -16,21 +16,21 @@ end box
 [-> LogicManager : execute("list")
 activate LogicManager
 
-LogicManager -> AddressBookParser : parseCommand("list")
-activate AddressBookParser
+LogicManager -> InputParser : parseCommand("list")
+activate InputParser
 
 create ListCommand
-AddressBookParser -> ListCommand
+InputParser -> ListCommand
 activate ListCommand
 
-ListCommand -> Model : updateFilteredPersonList
+ListCommand -> Model : updateFilteredPatientList
 
 Model -> ListCommand : (patient1, patient2)
 ListCommand --> Model
 Model --> ListCommand
-ListCommand -> Model: deletePerson
+ListCommand -> Model: deletePatient
 Model --> ListCommand
-ListCommand -> Model: addPerson
+ListCommand -> Model: addPatient
 Model --> ListCommand
 
 ListCommand -> CommandResult: sortedList

diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml
@@ -23,7 +23,7 @@ Class Sex
 Class Appointment
 Class UniqueVisitList
 Class SexOption
-Class Visit
+
 
 Class I #FFFFFF
 }
@@ -49,10 +49,9 @@ Patient *--> Address
 Patient *--> DateOfBirth
 Patient *--> Sex
 Patient *--> Appointment
-Patient *--> UniqueVisitList
 
+Patient *-right-> "1"UniqueVisitList
 Sex *--> SexOption
-UniqueVisitList --> "~* all" Visit
 
 Patient -[hidden]up--> I
 UniquePatientList -[hidden]right-> I
@@ -62,6 +61,9 @@ Phone -[hidden]right-> Email
 Email -[hidden]right-> Address
 Address -[hidden]right-> DateOfBirth
 DateOfBirth -[hidden]right-> Sex
+Sex -[hidden]right-> Appointment
+Appointment -[hidden]up-> UniqueVisitList
+
 
 ModelManager --> "~* filtered" Patient
 @enduml
diff --git a/docs/diagrams/StorageClassDiagram.puml b/docs/diagrams/StorageClassDiagram.puml
@@ -29,13 +29,15 @@ HiddenOutside ..> Storage
 
 StorageManager .up.|> Storage
 StorageManager -up-> "1" UserPrefsStorage
+
 StorageManager -up-> "1" PatientListStorage
 
 Storage -left-|> UserPrefsStorage
 Storage -right-|> PatientListStorage
 
 JsonUserPrefsStorage .up.|> UserPrefsStorage
 JsonPatientListStorage .up.|> PatientListStorage
+
 JsonPatientListStorage ..> JsonSerializablePatientList
 JsonSerializablePatientList --> "*" JsonAdaptedPatient
 JsonAdaptedPatient --> "*" JsonAdaptedVisit

diff --git a/docs/diagrams/VisitModelClassDiagram.puml b/docs/diagrams/VisitModelClassDiagram.puml
@@ -0,0 +1,14 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor MODEL_COLOR
+skinparam classBackgroundColor MODEL_COLOR
+
+Patient *--> "1" UniqueVisitList
+
+UniqueVisitList -down-> Visit
+
+Visit *--> Condition
+Visit *--> Severity
+Visit *--> DateOfVisit
+@enduml
diff --git a/docs/diagrams/tracing/LogicSequenceDiagram.puml b/docs/diagrams/tracing/LogicSequenceDiagram.puml
@@ -3,20 +3,20 @@
 skinparam ArrowFontStyle plain
 
 Participant ":LogicManager" as logic LOGIC_COLOR
-Participant ":AddressBookParser" as abp LOGIC_COLOR
+Participant ":InputParser" as ip LOGIC_COLOR
 Participant ":EditCommandParser" as ecp LOGIC_COLOR
 Participant "command:EditCommand" as ec LOGIC_COLOR
 
 [-> logic : execute
 activate logic
-logic -> abp ++: parseCommand(commandText)
+logic -> ip ++: parseCommand(commandText)
 create ecp
-abp -> ecp
-abp -> ecp ++: parse(arguments)
+ip -> ecp
+ip -> ecp ++: parse(arguments)
 create ec
-ecp -> ec ++: index, editPersonDescriptor
+ecp -> ec ++: index, editPatientDescriptor
 ec --> ecp --
-ecp --> abp --: command
-abp --> logic --: command
+ecp --> ip --: command
+ip --> logic --: command
 
 @enduml