Skip to content

Commit

Permalink
Merge pull request #368 from gohqingkhang/branch-UpdateForRelease
Browse files Browse the repository at this point in the history
Branch update for release
  • Loading branch information
Tanziyanghenry authored Nov 11, 2024
2 parents 79255dc + 7ac7b42 commit 6aab368
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 18 deletions.
14 changes: 0 additions & 14 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@
<!-- * Table of Contents -->
<page-nav-print />

<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

## **Setting up, getting started**
Expand Down Expand Up @@ -44,8 +42,6 @@ The bulk of the app's work is done by the following four components:

[**`Commons`**](#common-classes) represents a collection of classes used by multiple other components.

<div style="page-break-after: always;"></div>

**How the architecture components interact with each other**

The *Sequence Diagram* below shows how the components interact with each other for the scenario where the user issues the command `delete 1`.
Expand All @@ -63,8 +59,6 @@ For example, the `Logic` component defines its API in the `Logic.java` interface

The sections below give more details of each component.

<div style="page-break-after: always;"></div>

### UI component

The **API** of this component is specified in [`Ui.java`](https://github.com/AY2425S1-CS2103-F12-4/tp/tree/master/src/main/java/seedu/address/ui/Ui.java)
Expand All @@ -82,8 +76,6 @@ The `UI` component,
* keeps a reference to the `Logic` component, because the `UI` relies on the `Logic` to execute commands.
* depends on some classes in the `Model` component, as it displays `Person` object residing in the `Model`.

<div style="page-break-after: always;"></div>

### Logic component

**API** : [`Logic.java`](https://github.com/AY2425S1-CS2103-F12-4/tp/tree/master/src/main/java/seedu/address/logic/Logic.java)
Expand Down Expand Up @@ -117,8 +109,6 @@ How the parsing works:
* When called upon to parse a user command, the `AddressBookParser` class creates an `XYZCommandParser` (`XYZ` is a placeholder for the specific command name e.g., `AddCommandParser`) which uses the other classes shown above to parse the user command and create a `XYZCommand` object (e.g., `AddCommand`) which the `AddressBookParser` returns back as a `Command` object.
* All `XYZCommandParser` classes (e.g., `AddCommandParser`, `DeleteCommandParser`, ...) inherit from the `Parser` interface so that they can be treated similarly where possible e.g, during testing.

<div style="page-break-after: always;"></div>

### Model component
**API** : [`Model.java`](https://github.com/AY2425S1-CS2103-F12-4/tp/tree/master/src/main/java/seedu/address/model/Model.java)

Expand All @@ -140,8 +130,6 @@ The `Model` component,

</box>

<div style="page-break-after: always;"></div>

### Storage component

**API** : [`Storage.java`](https://github.com/AY2425S1-CS2103-F12-4/tp/tree/master/src/main/java/seedu/address/storage/Storage.java)
Expand All @@ -159,8 +147,6 @@ Classes used by multiple components are in the `seedu.address.commons` package.

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

## **Implementation**

This section describes some noteworthy details on how certain features are implemented.
Expand Down
4 changes: 0 additions & 4 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,6 @@ Format: `addEcName INDEX en/[ECNAME]`
**Tip:** You can delete the emergency contact's name by leaving the `ECNAME` field empty.
</box>

<div style="page-break-after: always;"></div>

* Adds the emergency contact's name `ECNAME` to the person at the specified `INDEX`
* Deletes the emergency contact's name at the specified `INDEX`
* The index **must be a positive integer** 1, 2, 3, …​
Expand Down Expand Up @@ -338,8 +336,6 @@ Format: `addSubmissionStatus INDEX sm/SUBMISSION_NAME ss/SUBMISSION_STATUS`
* The submission status can be edited using the same command with a different submission status.
* The index **must be a positive integer** 1, 2, 3, …​

<div style="page-break-after: always;"></div>

Examples:
* `addSubmissionStatus 1 sm/Assignment 1 ss/Y`
* `addSubmissionStatus 1 sm/Tutorial 2 ss/NIL`
Expand Down

0 comments on commit 6aab368

Please sign in to comment.