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

[CS2113-T11-2] IHospital #17

Open
wants to merge 297 commits into
base: master
Choose a base branch
from

Conversation

Demonshaha
Copy link

No description provided.

Copy link

@froststein froststein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally this is a good start for a developer guide, just need to clean up on the sequence diagrams, and add more explanations for each command.


The following sequence diagram shows how the exit operation works:

![](ByeCommand.png)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image
For the sequence diagram, consider naming it as fullCommand:datatype, assuming if your return from parser is a string, you could put fullCommand:String instead.

image
Similarly for your last 2 return arrows containing the Goodbye message you could consider putting it as "message:String" instead.

image
For the arguments in the methods for saveDoctorList(), savePatientList(), saveApppointmentList() consider putting the data type as well. For example, "doctors:ArrayList" if your data type is ArrayList<Doctors>.

image
All of the object calls are missing the activation bar, consider adding them.

image
Consider removing the extra boxes that appear at the bottom, I think PlantUML can remove it, if not so you may have to remove it manually.

### Exit program
Step 1: User type "bye" as input to exit the program. IHospital will call Parser#getCommand()
to return the user command received.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider explaining that upon exit, the data is saved, so that all the steps in the sequence diagram is explained.

The doctor list acts as a database storage containing the information of a list of doctors.
Once the doctor is removed from the doctor list, the system informs the user that the doctor is successfully removed

![](DeleteDoctor.jpg)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using the same software as the previous 2 diagrams, I understand that NTU provides visual paradigm, but it would be good to standardize the diagrams across the DG.

From what I know the numbering is auto added when using visual paradigm, so consider removing it? If I am not wrong, its not wrong to have numbering, but you may have to check with Prof if the numberings are allowed.

image
The alignment for 1.1.1:deleteDoctor() is a little off, consider moving it higher.

image
The return arrows from methods should be dotted lines instead of solid lines.

You may want to check with Prof if there is a need for an activation bar for the User.


The following sequence diagram shows how the add operation works:

![](AddDoctor.png)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image
Similarly for here, the activation bars are missing.
image
Similar mistakes as the above diagram, where the return arrow should have the datatype.

image
Similarly, should remove the bottom boxes as well.

Perhaps you could have a line break for long comments so that you diagram would not appear very long. As the current diagram is a little difficult to read.


### Add Doctor
Step 1: User type add command to add a doctor into the system and provide information required.
IHospital will call Parser#getCommand() to return the user command received, it will then call

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider renaming the Parser#getCommand() to Parser#getCommand

![](ByeCommand.png)

### Add Doctor
Step 1: User type add command to add a doctor into the system and provide information required.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps add an example of the command instead of writing it in plain English.

E.g. User types in add doctor to add a doctor....


Step 2: IHospital will call execute of the AddDoctorCommand object and AddDoctorCommand will
create a new Doctor with the given information and add it into DoctorList using
DoctorList#addDoctor(doctor).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similarly for here, DoctorList#addDoctor(doctor) could be DoctorList#addDoctor

cczhouqi and others added 30 commits April 10, 2022 21:32
Add output images for AddPatient and SearchAppointment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants