Skip to content

Commit

Permalink
Update developer guide with the new diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
tsulim committed Apr 14, 2024
1 parent 436165f commit 134f29b
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,10 @@ The below sequence diagram goes into more details on how the execution of the co
1. `FavCommand` calls the static `FavCommand#createFavPerson(personToFav)` function which calls for the static `PersonUtil#createPersonWithFavouriteStatus(Person selectedPerson, Favourite favourite)` using the `selectedPerson` and a new `Favourite` with the value `true`.
2. This static `PersonUtil#createPersonWithFavouriteStatus(Person selectedPerson, Favourite favourite)` function creates a new `Person` with the given `Favourite` and returns back to `FavCommand`.

The following activity diagram summarizes what happens when a user executes a new `fav` command:

![Fav Activity Diagram](images/FavActivityDiagram.png)

Similarly, the following diagrams shows how the `unfav 1` command works:

![Unfav Command Sequence Diagram](images/UnfavSequenceDiagram.png)
Expand All @@ -418,6 +422,10 @@ The below sequence diagram goes into more details on how the execution of the co
1. `UnfavCommand` calls the static `UnfavCommand#createUnfavPerson(personToUnfav)` function which calls for the static `PersonUtil#createPersonWithFavouriteStatus(Person selectedPerson, Favourite favourite)` using the `selectedPerson` and a new `Favourite` with the value `false`.
2. This static `PersonUtil#createPersonWithFavouriteStatus(Person selectedPerson, Favourite favourite)` function creates a new `Person` with the given `Favourite` attribute and returns back to `UnfavCommand`.

The following activity diagram summarizes what happens when a user executes a new `unfav` command:

![Unfav Activity Diagram](images/UnfavActivityDiagram.png)

### \[Proposed\] Undo/redo feature

#### Proposed Implementation
Expand Down

0 comments on commit 134f29b

Please sign in to comment.