Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/AY2324S2-CS2103T-T15-1/tp
Browse files Browse the repository at this point in the history
…into branch-logging

# Conflicts:
#	src/main/java/seedu/address/logic/commands/AddDoctorCommand.java
  • Loading branch information
officialchengyud committed Apr 15, 2024
2 parents 5846814 + d9b4386 commit 869d9f8
Show file tree
Hide file tree
Showing 107 changed files with 1,753 additions and 974 deletions.
2 changes: 1 addition & 1 deletion docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,5 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
[[portfolio](https://www.linkedin.com/in/eugene-sim-866677188/)]

* Role: Documentation, Testing, Intellij / Github Expert
* Responsibilities: Ensures the testing of the project is done properly and on time. Responsible for the quality of various project documents.
* Responsibilities: Ensures the testing of the project is done properly and on time. Responsible for the quality of various project documents.
* Helps other team member with matters related to Intellij, Github and Sourcetree tool.
871 changes: 708 additions & 163 deletions docs/DeveloperGuide.md

Large diffs are not rendered by default.

546 changes: 402 additions & 144 deletions docs/UserGuide.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/_layouts/page.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
---
<article class="post">

<img id="logo" src="images/medicli_logo.png" alt="MediCLI Logo" width="100">
<header class="post-header">
<h1 class="post-title">{{ page.title | escape }}</h1>
</header>
Expand Down
14 changes: 14 additions & 0 deletions docs/assets/css/style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,17 @@
height: 21px;
width: 21px
}

h2, h3 {
font-weight: bold;
color: #257ec7;
}

.post-title {
color: #257ec7;
font-weight: bold;
}

#logo {
margin-bottom: 15px;
}
21 changes: 21 additions & 0 deletions docs/diagrams/AppointmentClassDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
@startuml
!include style.puml
skinparam arrowThickness 1.1
skinparam arrowColor UI_COLOR_T4
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

20 changes: 20 additions & 0 deletions docs/diagrams/AppointmentObjectDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
@startuml
!include style.puml
skinparam arrowThickness 1.1
skinparam arrowColor UI_COLOR_T4
skinparam classBackgroundColor UI_COLOR

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
2 changes: 1 addition & 1 deletion docs/diagrams/DeleteAppointmentActivityDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ skinparam ActivityFontSize 15
skinparam ArrowFontSize 12

start
:User enters command to appointment;
:User enters command to delete appointment;

if () then ([command is invalid])
:Show error message\nfor invalid command;
Expand Down
26 changes: 26 additions & 0 deletions docs/diagrams/EditAppointmentActivityDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
@startuml
skin rose
skinparam ActivityFontSize 15
skinparam ArrowFontSize 12

start
:User enters command to edit appointment;

if () then ([command is invalid])
:Show error message\nfor invalid command;
else ([else])
if () then ([missing required fields])
:Show error message\nfor missing required fields;
else ([else])
if () then ([Invalid appointment index detected])
:Show error message\nindicating invalid Appointment index;
else ([else])
:edit appointment\nin the appointment list;
:Update the 'appointment' panel\nin the GUI;
:Show success message\nwith edited appointment information;
endif;
endif
endif

stop
@enduml
65 changes: 65 additions & 0 deletions docs/diagrams/EditAppointmentSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
@startuml
!include style.puml
skinparam ArrowFontStyle plain

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant ":EditAppointmentCommandParser" as EditAppointmentCommandParser LOGIC_COLOR
participant "e:EditAppointmentCommand" as EditAppointmentCommand LOGIC_COLOR
participant ":CommandResult" as CommandResult LOGIC_COLOR
end box

box Model MODEL_COLOR_T1
participant ":Model" as Model MODEL_COLOR
end box

[-> LogicManager : execute("editappt i/...")
activate LogicManager

LogicManager -> AddressBookParser : parseCommand("editappt i/...")
activate AddressBookParser

create EditAppointmentCommandParser
AddressBookParser -> EditAppointmentCommandParser
activate EditAppointmentCommandParser

create EditAppointmentCommand
EditAppointmentCommandParser -> EditAppointmentCommand : : parse("editappt i/...")
activate EditAppointmentCommand

EditAppointmentCommand --> EditAppointmentCommandParser
deactivate EditAppointmentCommand

EditAppointmentCommandParser --> AddressBookParser
deactivate EditAppointmentCommandParser

'Hidden arrow to position the destroy marker below the end of the activation bar.
EditAppointmentCommandParser -[hidden]-> AddressBookParser
destroy EditAppointmentCommandParser

AddressBookParser --> LogicManager
deactivate AddressBookParser

LogicManager -> EditAppointmentCommand : execute()
activate EditAppointmentCommand

EditAppointmentCommand -> Model : setAppointment(toEdit)
activate Model

Model --> EditAppointmentCommand
deactivate Model

create CommandResult
EditAppointmentCommand -> CommandResult
activate CommandResult

CommandResult --> EditAppointmentCommand : result
deactivate CommandResult

EditAppointmentCommand --> LogicManager : result
deactivate EditAppointmentCommand

[<--LogicManager
deactivate LogicManager
@enduml
26 changes: 26 additions & 0 deletions docs/diagrams/EditPersonActivityDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
@startuml
skin rose
skinparam ActivityFontSize 15
skinparam ArrowFontSize 12

start
:User enters command to edit doctor or patient;

if () then ([command is invalid])
:Show error message\nfor invalid command;
else ([else])
if () then ([missing required fields])
:Show error message\nfor missing required fields;
else ([else])
if () then ([Invalid person index detected])
:Show error message\nindicating invalid Person index;
else ([else])
:Edit patient/doctor\nfrom the persons list\nalso updates any appointments\nassociated with the edited patient/doctor;
:Update the 'person' panel\nand appointments panel\n in the GUI;
:Show success message\nwith edited doctor/patient information;
endif;
endif
endif

stop
@enduml
65 changes: 65 additions & 0 deletions docs/diagrams/EditPersonSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
@startuml
!include style.puml
skinparam ArrowFontStyle plain

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant ":EditCommandParser" as EditCommandParser LOGIC_COLOR
participant "e:EditCommand" as EditCommand LOGIC_COLOR
participant ":CommandResult" as CommandResult LOGIC_COLOR
end box

box Model MODEL_COLOR_T1
participant ":Model" as Model MODEL_COLOR
end box

[-> LogicManager : execute("edit i/...")
activate LogicManager

LogicManager -> AddressBookParser : parseCommand("edit i/...")
activate AddressBookParser

create EditCommandParser
AddressBookParser -> EditCommandParser
activate EditCommandParser

create EditCommand
EditCommandParser -> EditCommand : : parse("edit i/...")
activate EditCommand

EditCommand --> EditCommandParser
deactivate EditCommand

EditCommandParser --> AddressBookParser
deactivate EditCommandParser

'Hidden arrow to position the destroy marker below the end of the activation bar.
EditCommandParser -[hidden]-> AddressBookParser
destroy EditCommandParser

AddressBookParser --> LogicManager
deactivate AddressBookParser

LogicManager -> EditCommand : execute()
activate EditCommand

EditCommand -> Model : setPerson(toEdit)
activate Model

Model --> EditCommand
deactivate Model

create CommandResult
EditCommand -> CommandResult
activate CommandResult

CommandResult --> EditCommand : result
deactivate CommandResult

EditCommand --> LogicManager : result
deactivate EditCommand

[<--LogicManager
deactivate LogicManager
@enduml
20 changes: 20 additions & 0 deletions docs/diagrams/FindActivityDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
@startuml
skin rose
skinparam ActivityFontSize 15
skinparam ArrowFontSize 12

start
:User enters command to query a person,\nthe person can be either a doctor or patient.;


if () then ([missing required fields])
:Show error message\nfor missing required fields;
else ([else])
:Search the person from person list;
:Update the 'person' panel\nin the GUI to display the list;
:Show success message\nwith found person(s) information;
endif


stop
@enduml
65 changes: 65 additions & 0 deletions docs/diagrams/FindPersonSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
@startuml
!include style.puml
skinparam ArrowFontStyle plain

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant ":FindCommandParser" as FindCommandParser LOGIC_COLOR
participant "e:FindCommand" as FindCommand LOGIC_COLOR
participant ":CommandResult" as CommandResult LOGIC_COLOR
end box

box Model MODEL_COLOR_T1
participant ":Model" as Model MODEL_COLOR
end box

[-> LogicManager : execute("find ...")
activate LogicManager

LogicManager -> AddressBookParser : parseCommand("find ...")
activate AddressBookParser

create FindCommandParser
AddressBookParser -> FindCommandParser
activate FindCommandParser

create FindCommand
FindCommandParser -> FindCommand : : parse("find ...")
activate FindCommand

FindCommand --> FindCommandParser
deactivate FindCommand

FindCommandParser --> AddressBookParser
deactivate FindCommandParser

'Hidden arrow to position the destroy marker below the end of the activation bar.
FindCommandParser -[hidden]-> AddressBookParser
destroy FindCommandParser

AddressBookParser --> LogicManager
deactivate AddressBookParser

LogicManager -> FindCommand : execute()
activate FindCommand

FindCommand -> Model : find(person)
activate Model

Model --> FindCommand
deactivate Model

create CommandResult
FindCommand -> CommandResult
activate CommandResult

CommandResult --> FindCommand : result
deactivate CommandResult

FindCommand --> LogicManager : result
deactivate FindCommand

[<--LogicManager
deactivate LogicManager
@enduml
20 changes: 20 additions & 0 deletions docs/diagrams/QueryDoctorActivityDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
@startuml
skin rose
skinparam ActivityFontSize 15
skinparam ArrowFontSize 12

start
:User enters command to query doctor(s);


if () then ([missing required fields])
:Show error message\nfor missing required fields;
else ([else])
:Search doctor(s) from person list;
:Update the 'person' panel\nin the GUI to display the list;
:Show success message\nwith queried doctor(s) information;
endif


stop
@enduml
Loading

0 comments on commit 869d9f8

Please sign in to comment.