Skip to content

Commit

Permalink
Merge pull request #263 from xCOLOURx/master
Browse files Browse the repository at this point in the history
Add page break for DG
  • Loading branch information
marquestye authored Nov 14, 2023
2 parents 89775d8 + 61e6bde commit 39253ef
Showing 1 changed file with 45 additions and 4 deletions.
49 changes: 45 additions & 4 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md).

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

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

## **Design**

### Architecture
Expand Down Expand Up @@ -79,6 +81,8 @@ 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/AY2324S1-CS2103T-T13-0/tp/blob/master/src/main/java/seedu/address/ui/Ui.java)
Expand All @@ -100,6 +104,8 @@ The `UI` component,

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

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

### Logic component

**API** : [`Logic.java`](https://github.com/AY2324S1-CS2103T-T13-0/tp/blob/master/src/main/java/seedu/address/logic/Logic.java)
Expand Down Expand Up @@ -145,6 +151,8 @@ How the parsing works:

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

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

### Model component
**API** : [`Model.java`](https://github.com/AY2324S1-CS2103T-T13-0/tp/blob/master/src/main/java/seedu/address/model/Model.java)

Expand Down Expand Up @@ -188,6 +196,8 @@ The `Storage` component,

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

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

### Database component

**API** : [`Database.java`](https://github.com/AY2324S1-CS2103T-T13-0/tp/blob/master/src/main/java/seedu/address/database/Database.java)
Expand Down Expand Up @@ -219,6 +229,8 @@ Classes used by multiple components are in the [`seedu.address.commons`](https:/

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

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

## **Implementation**

This section describes some noteworthy details on how certain features and commands are implemented.
Expand All @@ -236,9 +248,10 @@ This section describes some noteworthy details on how certain features and comma

<br>


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

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

### Module Plan

#### Overview
Expand Down Expand Up @@ -323,6 +336,8 @@ Alternative 1 is ultimately chosen as it helps abstracts out the logic for diffe

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

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

### Module Storage

#### Overview
Expand Down Expand Up @@ -376,9 +391,9 @@ execution.

This can be seen in the sequence diagram below

<puml src="diagrams/StorageInitSequenceDiagram.puml" width="600"/>
<puml src="diagrams/StorageInitUserPrefSequenceDiagram.puml" width="5500" />
<puml src="diagrams/StorageInitStorageManagerSequenceDiagram.puml" width="400"/>
<puml src="diagrams/StorageInitSequenceDiagram.puml" />
<puml src="diagrams/StorageInitUserPrefSequenceDiagram.puml" width="550" />
<puml src="diagrams/StorageInitStorageManagerSequenceDiagram.puml" width="550"/>
<puml src="diagrams/StorageInitModulePlanSequenceDiagram.puml" />


Expand All @@ -387,6 +402,8 @@ This can be seen in the sequence diagram below

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

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

### Module Data

#### Overview
Expand Down Expand Up @@ -442,6 +459,8 @@ In such cases where the data cannot be read successfully, a `RuntimeException` i

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

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

### Add Module Command

#### Overview
Expand Down Expand Up @@ -493,6 +512,8 @@ And here is the *Sequence Diagram* showing the command being executed:

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

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

### Edit Module Command

#### Overview
Expand Down Expand Up @@ -521,6 +542,8 @@ As can be seen, this is a helpful class to store fields that need to be edited.

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

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

### Delete Module Command

#### Overview
Expand Down Expand Up @@ -568,6 +591,8 @@ The following sequence diagram shows how the `delete` command works:

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

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

### Info Module Command

#### Overview
Expand Down Expand Up @@ -596,6 +621,8 @@ During command execution, the `info` command calls `Module#toInfoString`, as sho

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

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

### Calculate CAP Command

#### Overview
Expand Down Expand Up @@ -626,6 +653,8 @@ The following sequence diagram shows how the `calculateCAP` command works:

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

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

### Calculate MC Command

#### Overview
Expand Down Expand Up @@ -656,6 +685,8 @@ The following sequence diagram shows how the `calculateMC` command works:

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

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

### \[Proposed\] Pre-requisite checking feature

#### Proposed Implementation
Expand Down Expand Up @@ -701,6 +732,8 @@ The following activity diagram summarizes what happens when a user executes a co

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

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

## **Future enhancements**

For our next steps, we plan to add the following features:
Expand Down Expand Up @@ -728,6 +761,8 @@ For our next steps, we plan to add the following features:

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

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

## **Appendix: Requirements**

### Product scope
Expand Down Expand Up @@ -796,6 +831,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
<br>
--------------------------------------------------------------------------------------------------------------------

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

### Use cases

(For all use cases below, the **System** is `ModCraft` and the **Actor** is the `user`, unless specified otherwise)
Expand Down Expand Up @@ -998,6 +1035,8 @@ Steps 1b1 and 1b2 are repeated until the user inputs the correct module code.
Use case resumes from step 2.

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

### Non-Functional Requirements

1. Should work on any mainstream OS as long as it has Java 11 or above installed.
Expand All @@ -1022,6 +1061,8 @@ Where pre-requisites are specified, equivalent courses will also be accepted. Fo

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

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

## **Appendix: Instructions for manual testing**

Given below are instructions to test the app manually.
Expand Down

0 comments on commit 39253ef

Please sign in to comment.