Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/AY2324S1-CS2103T-T10-3/tp
Browse files Browse the repository at this point in the history
…into v1.4c
  • Loading branch information
Kailash201 committed Nov 14, 2023
2 parents ff6d131 + 8f65b73 commit 9e51b86
Show file tree
Hide file tree
Showing 6 changed files with 48 additions and 47 deletions.
2 changes: 1 addition & 1 deletion docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
[[github](http://github.com/Kailash201)]
[[portfolio](team/kailash201.md)]

* Roel: Developer
* Role: Developer
* Role: Team Lead

### Huang Yixin
Expand Down
66 changes: 33 additions & 33 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ pageNav: 3

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

## **1. Introduction**
## 1. Introduction

### **1.1. Product Overview**
ProjectPro is a contacts organisation application designed for university students.
Expand All @@ -25,22 +25,22 @@ This app can help to save time by:

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

### **1.2. Setting up, getting started**
### 1.2 Setting up getting started

Refer to the guide [_Setting up and getting started_](SettingUp.md).

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

### **1.3. Acknowledgements**
### 1.3 Acknowledgements

ProjectPro is a brownfield Java Project based on the AB3 project template created by the [SE-EDU initiative](https://se-education.org).


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

## **2. Design**
## 2 Design

### 2.1. Architecture
### 2.1 Architecture

<puml src="diagrams/ArchitectureDiagram.puml" width="280" />

Expand Down Expand Up @@ -82,7 +82,7 @@ For example, the `Logic` component defines its API in the `Logic.java` interface

The sections below give more details of each component.

### 2.2. UI component
### 2.2 UI component

The **API** of this component is specified in [`Ui.java`](https://github.com/AY2324S1-CS2103T-T10-3/tp/blob/master/src/main/java/seedu/address/ui/Ui.java)

Expand All @@ -101,7 +101,7 @@ 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`.

### 2.3. Logic component
### 2.3 Logic component

**API** : [`Logic.java`](https://github.com/AY2324S1-CS2103T-T10-3/tp/blob/master/src/main/java/seedu/address/logic/Logic.java)

Expand Down Expand Up @@ -133,7 +133,7 @@ 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.

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

<puml src="diagrams/ModelClassDiagram.puml" width="450" />
Expand All @@ -147,7 +147,7 @@ The `Model` component
* does not depend on any of the other three components (as the `Model` represents data entities of the domain, they should make sense on their own without depending on other components)


### 2.5. Storage component
### 2.5 Storage component

**API** : [`Storage.java`](https://github.com/AY2324S1-CS2103T-T10-3/tp/blob/master/src/main/java/seedu/address/storage/Storage.java)

Expand All @@ -162,17 +162,17 @@ With the inclusion of `Group` and `TimeIntervals` in our application, more compo

To address this requirement, we updated our storage to save both classes in JSON format.

### 2.6. Common classes
### 2.6 Common classes

Classes used by multiple components are in the `seedu.addressbook.commons` package.

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

## **3. Implementation**
## 3 Implementation

This section describes some noteworthy details on how certain features are implemented.

### 3.1. Adding a Person
### 3.1 Adding a Person

#### Implementation

Expand All @@ -197,7 +197,7 @@ The following sequence diagram describes the process of `add` command:

</box>

#### Design consideration:
#### Design considerations:

**Aspect: Handling group attribute in user input**

Expand All @@ -211,7 +211,7 @@ The following sequence diagram describes the process of `add` command:

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

### 3.2. Adding a Group
### 3.2 Adding a Group

#### Proposed Implementation

Expand All @@ -237,7 +237,7 @@ Below is a sequence diagram that summarizes how a user creates a new group:

</box>

#### Design Considerations
#### Design Considerations:

**Aspect: Groups with the same name**

Expand All @@ -251,7 +251,7 @@ Below is a sequence diagram that summarizes how a user creates a new group:

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

### 3.3. Delete Person and Group
### 3.3 Delete Person and Group

#### Implementation

Expand Down Expand Up @@ -302,7 +302,7 @@ The Delete Group command mechanism behaves the same as the Delete Person command

Additionally, `AddressBook#removeGroup(Group g)` will remove the target group 'g' from the group lists of all the members that were a part of it by calling `Person#removeGroup(Group g)`.

#### Design Considerations
#### Design Considerations:

**Aspect: How to handle two similar but different commands (delete group and delete person)**

Expand All @@ -315,9 +315,9 @@ Additionally, `AddressBook#removeGroup(Group g)` will remove the target group 'g
* Cons: Users have to remember more command words which may take more time to get used to

--------------------------------------------------------------------------------------------------------------------
### 3.4. List Person and list group
### 3.4 List Person and list group

### List Person
### List-Person

The List mechanism is facilitated by the `Model` class.

Expand Down Expand Up @@ -366,7 +366,7 @@ The following activity diagram summarizes what happens when a user executes a li

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

### 3.5. Find Person and Find Group features
### 3.5 Find Person and Find Group features

#### Implementation

Expand Down Expand Up @@ -413,7 +413,7 @@ The Find Group mechanism works like the Find Person mechanism, expect it filters

Additionally, it calls on an extra method `Group#getGroupRemark()`. `Group#getGroupRemarks()` will be called to display the previously saved group remarks to the user.

#### Design Considerations
#### Design Considerations:

**Aspect: How to handle two similar but different commands (find by group and find by name)**

Expand All @@ -437,7 +437,7 @@ Additionally, it calls on an extra method `Group#getGroupRemark()`. `Group#getGr

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

### 3.6. Group and Ungrouping Person
### 3.6 Group and Ungrouping Person

#### Implementation

Expand Down Expand Up @@ -476,7 +476,7 @@ The following activity diagram summarizes what happens when a user executes a ne

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

### 3.7. Adding a Group Remark
### 3.7 Adding a Group Remark

#### Implementation

Expand Down Expand Up @@ -518,7 +518,7 @@ The following activity diagram summarizes what happens when a user executes a ne

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

### 3.8. Adding Time to a Person or Group
### 3.8 Adding Time to a Person or Group

#### Implementation

Expand Down Expand Up @@ -589,7 +589,7 @@ The Add Time to Group command mechanism behaves the same as the Add Time to Pers

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

### 3.9. Delete Time Feature
### 3.9 Delete Time Feature

#### Implementation

Expand Down Expand Up @@ -666,7 +666,7 @@ The Delete Time from Group command mechanism behaves the same as the Delete Time

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

### 3.10. Listing Time for a Person or Group
### 3.10 Listing Time for a Person or Group

#### Implementation

Expand Down Expand Up @@ -739,7 +739,7 @@ The List Time from Group command mechanism behaves the same as the List Time fro

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

### 3.11. Find Free Time
### 3.11 Find Free Time
#### Implementation

The FindFreeTime mechanism is facilitated by the `Model`, `Group` and `Person` class. It retrieves `Group` from `Model` to find a free time between group members in `listOfGroupMates` in `Group` with a duration specified, `Duration`. The operation is exposed to `Model` interface as `Model#findGroup`.
Expand All @@ -759,9 +759,9 @@ The following activity diagram summarizes what happens when a user executes a Fi
<puml src="diagrams/FindFreeTimeActivityDiagram.puml" alt="FindFreeTimeActivityDiagram" />
--------------------------------------------------------------------------------------------------------------------

## 4. Planned Enhancements
## 4 Planned Enhancements

### 4.1. Undo/redo feature
### 4.1 Undo/redo feature

Currently, we do not have undo and redo feature which open rooms for users to accidentally have typos in their command messages, causing certain unwanted commands to be executed. This can cause an array of problems,
from deleting important data along with the contact, to inconvenience for the users themselves. As such, we plan to implement undo and redo feature in the future to provide a better user experience for our users.
Expand All @@ -785,7 +785,7 @@ In the `addmeeting` feature, user can add free time intervals to a group. Curren

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

## **5. Documentation, logging, testing, configuration, dev-ops**
## 5 Documentation logging testing configuration dev-ops

* [Documentation guide](Documentation.md)
* [Testing guide](Testing.md)
Expand All @@ -795,7 +795,7 @@ In the `addmeeting` feature, user can add free time intervals to a group. Curren

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

## **6. Appendix: Requirements**
## 6 Appendix Requirements

### 6.1. Product scope

Expand Down Expand Up @@ -1148,7 +1148,7 @@ Use Case ends.

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

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

Given below are instructions to test the app manually.

Expand Down Expand Up @@ -1451,7 +1451,7 @@ testers are expected to do more *exploratory* testing.

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

## **8. Appendix: Effort**
## 8 Appendix Effort

ProjectPRO is a project built upon AB3, which was built out of the SE-EDU initiative. Our group has been actively working on ProjectPRO this semester, meeting regularly to discuss about our application to meet deadlines punctually.

Expand Down
3 changes: 1 addition & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,7 @@ Welcome back to ProjectPRO. Simply head over to our Features section to gain ins
1. Open a command terminal.
2. Type `cd Desktop` , followed by `cd ProjectPro`.
3. Type `java -jar ProjectPRO.jar` to run the application.


<p></p>
5. Start using ProjectPRO!

--------------------------------------------------------------------------------------------------------------------
Expand Down
18 changes: 10 additions & 8 deletions docs/_markbind/layouts/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,16 @@
* [Quick Start]({{ baseUrl }}/UserGuide.html#quick-start)
* [Features]({{ baseUrl }}/UserGuide.html#features)
* [Developer Guide]({{ baseUrl }}/DeveloperGuide.html) :expanded:
* [Acknowledgements]({{ baseUrl }}/DeveloperGuide.html#1.3.-Acknowledgement)
* [Setting Up]({{ baseUrl }}/DeveloperGuide.html#1.2.-Setting up, getting started)
* [Design]({{ baseUrl }}/DeveloperGuide.html#2.-Design)
* [Implementation]({{ baseUrl }}/DeveloperGuide.html#Implementation)
* [Documentation, logging, testing, configuration, dev-ops]({{ baseUrl }}/DeveloperGuide.html#5.-Documentation, logging, testing, configuration, dev-ops)
* [Appendix: Requirements]({{ baseUrl }}/DeveloperGuide.html#6.-Appendix: Requirements)
* [Appendix: Instructions for manual testing]({{ baseUrl }}/DeveloperGuide.html#7.-Appendix: Instructions for manual testing)
* [About Us]({{ baseUrl }}/AboutUs.html)
* [Introduction]({{ baseUrl }}/DeveloperGuide.html#1.-introduction)
* [Design]({{ baseUrl }}/DeveloperGuide.html#2-design)
* [Implementation]({{ baseUrl }}/DeveloperGuide.html#3-implementation)
* [Planned Enhancements]({{ baseUrl }}/DeveloperGuide.html#4-planned-enhancements)
* [Documentation and Testing]({{ baseUrl }}/DeveloperGuide.html#5-documentation-logging-testing-configuration-dev-ops)
* [Requirements]({{ baseUrl }}/DeveloperGuide.html#6-appendix-requirements)
* [Manual Testing]({{ baseUrl }}/DeveloperGuide.html#7-appendix-instructions-for-manual-testing)
* [Effort]({{ baseUrl }}/DeveloperGuide.html#8-appendix-effort)
* [About us]({{ baseUrl }}/AboutUs.html) :expanded:
* [Introduction]({{ baseUrl }}/AboutUs.html#about-us)
</site-nav>
</div>
</nav>
Expand Down
4 changes: 2 additions & 2 deletions docs/team/coderhuang559.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ Given below are my contributions to the project.

* **Documentation**:
* User Guide:
* Added documentation for the features `remark` for contacts, `listtime` for contacts, `addmeeting` for groups and `deletetime` for groups. [\#144](https://github.com/AY2324S1-CS2103T-T10-3/tp/pull/144)
* Added documentation for the features `deletetime` for contacts, `listtime` for contacts, `addmeeting` and `deletetime` for groups. [\#144](https://github.com/AY2324S1-CS2103T-T10-3/tp/pull/144)
* Developer Guide:
* Added implementation details of the `remark`, `listtime` for person and group, `addtime`, and `addmeeting` features [\#270](https://github.com/AY2324S1-CS2103T-T10-3/tp/pull/270/files).
* Added implementation details of the `remark`, `listtime` for contacts and groups, `addtime`, and `addmeeting` features [\#270](https://github.com/AY2324S1-CS2103T-T10-3/tp/pull/270/files).
* Added activity and sequence diagrams for the above functions.

* **Contributions beyond project team**
Expand Down
2 changes: 1 addition & 1 deletion docs/team/kailash201.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Given below are my contributions to the project.
* **Documentation**:
* User Guide:
* Added documentation for the features `list`, `new`, `delete`, `find`. [\#145](https://github.com/AY2324S1-CS2103T-T10-3/tp/pull/146)
* Made some updates to the documentation for the final release. [\#290](https://github.com/AY2324S1-CS2103T-T10-3/tp/pull/290), [\#277](https://github.com/AY2324S1-CS2103T-T10-3/tp/pull/277), [\#271](https://github.com/AY2324S1-CS2103T-T10-3/tp/pull/271/files#diff-b50feaf9240709b6b02fb9584696b012c2a69feeba89e409952cc2f401f373fb)
* Made some updates to the documentation for the final release. [\#290](https://github.com/AY2324S1-CS2103T-T10-3/tp/pull/290), [\#277](https://github.com/AY2324S1-CS2103T-T10-3/tp/pull/277), [\#271](https://github.com/AY2324S1-CS2103T-T10-3/tp/pull/271)
* Developer Guide:
* Added implementation details of the `add` and `addtime`feature. [\#271] (https://github.com/AY2324S1-CS2103T-T10-3/tp/pull/271/files)
* Made diagrams for `add` and `addtime` feature.
Expand Down

0 comments on commit 9e51b86

Please sign in to comment.