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

Update UG #225

Merged
merged 6 commits into from
Nov 14, 2023
Merged

Update UG #225

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0a3b2e5
Merge branch 'master' of https://github.com/AY2324S1-CS2103T-W09-4/tp
Nov 14, 2023
a86fde3
Merge branch 'master' into branch-UG
Nov 14, 2023
1e7585c
Update UG
Nov 14, 2023
524cb6a
Update DG
Nov 14, 2023
f008dcb
Update comments
Nov 14, 2023
393e47f
Update UG
Nov 14, 2023
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
4 changes: 2 additions & 2 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The sections below give more details of each component.

The **API** of this component is specified in [`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java)

<puml src="/diagrams/UiClassDiagram.puml" alt="Structure of the UI Component"/>
<puml src="diagrams/UiClassDiagram.puml" alt="Structure of the UI Component"> </puml>

The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PersonListPanel`, `PersonInformationPanel`, `SummaryStatisticScreen` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI.
The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/resources/view/MainWindow.fxml)
Expand All @@ -88,7 +88,7 @@ The `UI` component,

Here's a (partial) class diagram of the `Logic` component:

<puml src="diagrams/LogicClassDiagram." width="550"/>
<puml src="diagrams/LogicClassDiagram.puml" width="550"/>

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

Expand Down
8 changes: 4 additions & 4 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,14 +170,14 @@ Not to worry, here are some steps you can take to fix this:
![UiBreakdown](images/uibreak.png)

| Colour | Component | Description |
| ---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| <img src="images/red_1.png" width="10px" height="10px"> | Menu Bar | Provides buttons for exiting, opening Help window, and opening Events window. |
| <img src="images/orange.png" width="10px" height="10px"> | Command Box | Allows you to enter a command. |
| <img src="images/yellow.png" width="10px" height="10px"> | Result Display | Displays the result of the command execution. |
| <img src="images/green.png" width="10px" height="10px"> | Applicant List Panel | Displays a list of all applicants in JABPro. |
| <img src="images/blue.png" width="10px" height="10px"> | Applicant Card | Displays certain details of an applicant for quick view, such as name, address, phone, email, tags, LinkedIn/GitHub username. |
| <img src="images/purple.png" width="10px" height="10px"> | Applicant Information Panel | Displays a detailed view of an applicant, providing information of status and remarks, in addition to the basic information about the applicant. |
| <img src="images/brown.png" width="10px" height="10px"> | Summary Statistics Panel | Displays summary statistics for a particular applicant pertaining to a specific tag. |
| <img src="images/brown.png" width="10px" height="10px"> | Applicant Card | Displays certain details of an applicant for quick view, such as name, address, phone, email, tags, LinkedIn/GitHub username. |
| <img src="images/blue.png" width="10px" height="10px"> | Applicant Information Panel | Displays a detailed view of an applicant, providing information of status and remarks, in addition to the basic information about the applicant. |
| <img src="images/purple.png" width="10px" height="10px"> | Summary Statistics Panel | Displays summary statistics for a particular applicant pertaining to a specific tag. |

In addition, there are windows such as:
* Help Window [accessed by the `help` command, or through Menu Bar].
Expand Down
Loading