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.

Sign up for GitHub

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

Branch centering diagrams #376

Merged
merged 2 commits into from
Nov 11, 2024
Merged

Branch centering diagrams #376

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f57f190
Merge branch 'master' into branch-centering-diagrams
yooplo Nov 11, 2024
6d7697e
Centre the remaining diagrams
yooplo Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ Each of the four main components (also shown in the diagram above),
* implements its functionality using a concrete `{Component Name}Manager` class (which follows the corresponding API `interface` mentioned in the previous point.

For example, the `Logic` component defines its API in the `Logic.java` interface and implements its functionality using the `LogicManager.java` class which follows the `Logic` interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.
<puml src="diagrams/ComponentManagers.puml" width="300"/>
<div style="text-align: center;">
<puml src="diagrams/ComponentManagers.puml" width="300"/>
</div>

The sections below give more details of each component.

Expand All @@ -92,7 +94,9 @@ The `UI` component,
**API** : [`Logic.java`](https://github.com/AY2425S1-CS2103T-F14a-4/tp/tree/master/src/main/java/seedu/address/logic/Logic.java)

Here's a (partial) class diagram of the `Logic` component:
<puml src="diagrams/LogicClassDiagram.puml" width="550"/>
<div style="text-align: center;">
<puml src="diagrams/LogicClassDiagram.puml" width="550"/>
</div>

The sequence diagram below illustrates the interactions within the `Logic` component, taking `execute("delete 1")` API call as an example.

Expand Down