Skip to content

Commit

Permalink
Fixed Checkstyle
Browse files Browse the repository at this point in the history
  • Loading branch information
pkpaing committed Mar 23, 2023
1 parent dd2e92b commit e875e79
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ The following activity diagram summarizes what happens when a user executes add-
- Path is easily invalidated (e.g. user moves/deletes/renames the image)
## Delete Image Feature
### Delete Image Implementation
The delete-image feature is facilitated by the classes `DeleteImageCommand`,
The delete-image feature is facilitated by the classes `DeleteImageCommand`,
`DeleteImageCommandParser`, `ImageUtil`, and `ParserUtil`.
The `DeleteImageCommandParser` first parses through the user command to obtain
the desired index through using `ParserUtil#parseIndex`. Following which an
Expand All @@ -243,7 +243,7 @@ which have already had an image added.

Step 2: The user decides that the image given to the contact at index 4 is not
suitable, and wants to delete it. The user inputs `delete-image 4`.
`DeleteImageCommandParser#parse` is then called to parse this input for the
`DeleteImageCommandParser#parse` is then called to parse this input for the
desired index.

> **Note**: If the user inputs an index of a contact which currently does not have
Expand Down Expand Up @@ -276,7 +276,7 @@ directory.
- Ensures application does not consume excess storage
- Cons:
- Extra complexity in requiring file i/o operations

- **Alternative 2:** Disregard deleting the image file from program directory.
- Pros:
- Easier to implement
Expand All @@ -285,18 +285,18 @@ directory.
its lifetime of usage
## Import Contacts Feature
### Import Contacts Implementation
The import feature is facilitated by the classes `ImportCommand`, `ImportCommandParser`,
The import feature is facilitated by the classes `ImportCommand`, `ImportCommandParser`,
`SocContacts` and `ChsContacts`. The `ImportCommandParser` first parses through the user
command to obtain the desired faculty to be imported. An instance of
a `ImportCommand` containing the desired faculty from either `SocContacts` or
`ChsContacts` is then returned. `ImportCommand#execute` is then called,
a `ImportCommand` containing the desired faculty from either `SocContacts` or
`ChsContacts` is then returned. `ImportCommand#execute` is then called,
which calls `Model#addPerson` to add the unique contacts into BookFace.

Given below is an example usage scenario for how the import mechanism behaves.

Step 1: User starts up the application and sees their list of contacts.
Step 1: User starts up the application and sees their list of contacts.

Step 2: User decides to import contacts from faculty SOC and input
Step 2: User decides to import contacts from faculty SOC and input
`import soc`. `ImportCommandParser#parse` is then called to parse
this input for the desired faculty.

Expand Down
2 changes: 1 addition & 1 deletion docs/diagrams/ImportActivityDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ else ([else])
: Display error message;
endif
stop
@enduml
@enduml

0 comments on commit e875e79

Please sign in to comment.