Skip to content

Commit

Permalink
Merge pull request #163 from Kurtyjlee/master
Browse files Browse the repository at this point in the history
Update page breaks
  • Loading branch information
leezhengjing authored Nov 13, 2023
2 parents 2bcefa9 + ab8df0c commit 186cae7
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 6 deletions.
28 changes: 27 additions & 1 deletion docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md).

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

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

## **Design**

<div markdown="span" class="alert alert-primary">
Expand Down Expand Up @@ -67,6 +69,8 @@ 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/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java)
Expand All @@ -86,6 +90,8 @@ The `UI` component,

[Scroll back to Table of Contents](#table-of-contents)

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

### Logic component

**API** : [`Logic.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/logic/Logic.java)
Expand Down Expand Up @@ -118,6 +124,8 @@ How the parsing works:

[Scroll back to Table of Contents](#table-of-contents)

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

### Model component
**API** : [`Model.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/model/Model.java)

Expand All @@ -144,6 +152,8 @@ The `Model` component,

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

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

The `Storage` component,
* can save both address book data and user preference data in JSON format, and read them back into corresponding objects.
* inherits from both `AddressBookStorage` and `UserPrefStorage`, which means it can be treated as either one (if only the functionality of only one is needed).
Expand All @@ -158,6 +168,9 @@ Classes used by multiple components are in the `seedu.addressbook.commons` packa
[Scroll back to Table of Contents](#table-of-contents)

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

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

## **Flow of Program Execution**

The way the user interacts with the program is illustrated as follows.
Expand Down Expand Up @@ -193,6 +206,9 @@ Note that even though EventList stores a list of Events, currently only Meetings

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


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

## **Implementation**

### Commands
Expand Down Expand Up @@ -525,6 +541,8 @@ The flow for the `remind` command is described by the following sequence diagram

[Scroll back to Table of Contents](#table-of-contents)

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

## **Proposed Features**

### \[Proposed\] Undo/redo feature
Expand Down Expand Up @@ -619,6 +637,8 @@ The following activity diagram summarizes what happens when a user executes a ne

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

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

## **Appendix: Requirements**

### Product scope
Expand Down Expand Up @@ -666,6 +686,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

[Scroll back to Table of Contents](#table-of-contents)

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

### Use cases

For all use cases below, unless specified otherwise:
Expand Down Expand Up @@ -997,7 +1019,9 @@ assigned to the event individually.
* 2a. The list is empty

Use case ends.


<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 Down Expand Up @@ -1030,6 +1054,8 @@ Contacts or groups can be assigned to a single meeting, allowing for efficient m

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

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

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

Given below are instructions to test the app manually.
Expand Down
6 changes: 1 addition & 5 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,7 @@ Format: `find_person KEYWORD [MORE_KEYWORDS]`

</div>

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

**Expected output when the command succeeds:**

Expand All @@ -361,9 +362,6 @@ Input: `find_person Alexa` displays all contacts with the name `Alexa` in the co
![result for 'find_person alex david'](images/findFriendsResult.png)


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


<div markdown="block" class="alert alert-warning">

**:exclamation: Disclaimer when using the `find_person` command:**<br>
Expand All @@ -372,7 +370,6 @@ Input: `find_person Alexa` displays all contacts with the name `Alexa` in the co

</div>


[Scroll back to Table of Contents](#table-of-contents)

<div style="page-break-after: always;"></div>
Expand Down Expand Up @@ -438,7 +435,6 @@ This is illustrated as follows:
![Person appearing multiple times](images/DuplicatePersonInDifferentGroups.png)

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


**This should be the expected output when the command succeeds:**
Expand Down

0 comments on commit 186cae7

Please sign in to comment.