Skip to content

Commit

Permalink
Merge pull request AY2324S2-CS2103-F08-3#275 from tsulim/270-resize-d…
Browse files Browse the repository at this point in the history
…iagrams-2

Resize remaining diagrams
  • Loading branch information
iynixil authored Apr 15, 2024
2 parents f52c4b6 + 9e7f94c commit 17e8b15
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 12 deletions.
8 changes: 4 additions & 4 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ How the parsing works:

**API** : [`Model.java`](https://github.com/AY2324S2-CS2103-F08-3/tp/blob/master/src/main/java/staffconnect/model/Model.java)

<img src="images/ModelClassDiagram.png" width="450" />
<img src="images/ModelClassDiagram.png" width="740" />

The `Model` component,

Expand All @@ -132,15 +132,15 @@ The `Model` component,
* stores the meeting book data i.e., all `Meeting` objects (which are contained in a `UniqueMeetingList` object) in each `Person` object.
<div markdown="span" class="alert alert-info">:information_source: **Note:** An alternative (arguably, a more OOP) model is given below. It has a `Tag` list in the `StaffBook`, which `Person` references. This allows `StaffBook` to only require one `Tag` object per unique tag, instead of each `Person` needing their own `Tag` objects.<br>

<img src="images/BetterModelClassDiagram.png" width="450" />
<img src="images/BetterModelClassDiagram.png" width="600" />

</div>

### Storage component

**API** : [`Storage.java`](https://github.com/AY2324S2-CS2103-F08-3/tp/blob/master/src/main/java/staffconnect/storage/Storage.java)

<img src="images/StorageClassDiagram.png" width="550" />
<img src="images/StorageClassDiagram.png" width="740" />

The `Storage` component,
* can save both staff book data and user preference data in JSON format, and read them back into corresponding objects.
Expand Down Expand Up @@ -294,7 +294,7 @@ Given below is an example usage scenario and how the sort mechanism behaves at e

The sequence diagram for executing a **"sort n/"** is shown below:

<img src="images/SortSequenceDiagram.png" width="850" />
<img src="images/SortSequenceDiagram.png" width="740" />

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

Expand Down
6 changes: 6 additions & 0 deletions docs/_sass/minima/_base.scss
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ img {
vertical-align: middle;
}

img:not([class]) {
margin-left: auto;
margin-right: auto;
display: block;
}



/**
Expand Down
10 changes: 6 additions & 4 deletions docs/diagrams/FavActivityDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
skin rose
skinparam ActivityFontSize 15
skinparam ArrowFontSize 12
skinparam DefaultTextAlignment center

start
:User executes fav command;

Expand All @@ -10,14 +12,14 @@ start

if () then ([index is valid])
if () then ([Person is favourite])
:Create new Person with same values but is a favourite;
:Replace the original Person with the new one;
:Create new Person with same\n values but is a favourite;
:Replace the original Person\n with the new one;
:Refresh the list of Persons;
else ([else])
:Show error message to user that person is already a favourite;
:Show error message to user\n that person is already a favourite;
endif
else ([else])
:Show error message to user that index is invalid;
:Show error message to user\n that index is invalid;
endif
stop
@enduml
10 changes: 6 additions & 4 deletions docs/diagrams/UnfavActivityDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
skin rose
skinparam ActivityFontSize 15
skinparam ArrowFontSize 12
skinparam DefaultTextAlignment center

start
:User executes unfav command;

Expand All @@ -10,14 +12,14 @@ start

if () then ([index is valid])
if () then ([Person is favourite])
:Create new Person with same values but is not a favourite;
:Replace the original Person with the new one;
:Create new Person with same\n values but is not a favourite;
:Replace the original Person\n with the new one;
:Refresh the list of Persons;
else ([else])
:Show error message to user that person is already not a favourite;
:Show error message to user\n that person is already not a favourite;
endif
else ([else])
:Show error message to user that index is invalid;
:Show error message to user\n that index is invalid;
endif
stop
@enduml
Binary file modified docs/images/FavActivityDiagram.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/UnfavActivityDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 17e8b15

Please sign in to comment.