Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update DG #250

Merged
merged 1 commit into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 87 additions & 69 deletions docs/DeveloperGuide.md

Large diffs are not rendered by default.

32 changes: 18 additions & 14 deletions docs/diagrams/AddAppoiintmentActivityDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,31 @@ skinparam ActivityFontSize 15
skinparam ArrowFontSize 12

start
:User enters command to add a patient;
:User inputs text command to add an appointment;

if () then ([command is invalid])
:Show error message\nfor invalid command;
if () then ([command word does not exist])
:Show error message\nfor unknown command word;
else ([else])
if () then ([missing required fields])
:Show error message\nfor missing required fields;
:Show error message indicating\n invalid command format;
else ([else])
if () then ([doctor/patient does not exist])
:Show error message\nindicating that the appointment is invalid;
if () then ([invalid field arguments])
:Show error message\nhighlighting invalid field\narguments provided;
else ([else])
if () then ([appointment date is invalid])
:Show error message\nindicating that the appointment is invalid;
if () then ([doctor/patient does not exist])
:Show error message\nindicating that the doctor/patient is not registered;
else ([else])
if () then ([Duplicate appointment detected])
:Show error message\nindicating duplicate appointment;
if () then ([appointment date is invalid])
:Show error message indicating that\n the appointment cannot be scheduled in the past;
else ([else])
:Add the appointment\ninto the appointment list;
:Update the 'appointment' panel\nin the GUI;
:Show success message\nwith appointments' information;
endif;
if () then ([Duplicate appointment detected])
:Show error message\nindicating duplicate appointment;
else ([else])
:Add the appointment\ninto the appointment list;
:Update the 'appointment' panel\nin the GUI;
:Show success message\nwith appointments' information;
endif;
endif
endif
endif
endif
Expand Down
6 changes: 3 additions & 3 deletions docs/diagrams/AddPersonActivityDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ skinparam ActivityFontSize 15
skinparam ArrowFontSize 12

start
:User enters command to add a patient/doctor;
:User inputs text command to add a patient/doctor;

if () then ([command is invalid])
:Show error message\nfor invalid command;
if () then ([command word does not exist])
:Show error message\nfor unknown command;
else ([else])
if () then ([missing required fields])
:Show error message\nfor missing required fields;
Expand Down
2 changes: 0 additions & 2 deletions docs/diagrams/AppointmentClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,13 @@ skinparam classBackgroundColor UI_COLOR

Class "Appointment" as Appointment
Class Nric
Class AppointmentId
Class AppointmentDateTime



Appointment -down-> "1" Nric : Doctor's NRIC\t
Appointment -down-> "1" Nric : Patient's NRIC\t\t
Appointment -down-> "\t1" AppointmentDateTime
Appointment -down-> "\t1" AppointmentId


@enduml
Expand Down
2 changes: 0 additions & 2 deletions docs/diagrams/AppointmentObjectDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,11 @@ object "__:Appointment__" as appointment
object "__doctorNric:Nric__" as doctorNric
object "__patientNric:Nric__" as patientNric
object "__appointmentDateTime:AppointmentDateTime__" as appointmentDate
object "__appointmentId:AppointmentId__" as appointmentId


appointment -down-> doctorNric
appointment -down-> patientNric
appointment -down-> appointmentDate
appointment -down-> appointmentId


@enduml
Binary file modified docs/images/AddAppoiintmentActivityDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/AppointmentClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/AppointmentObjectDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading