Skip to content

Commit 807c893

Browse files
authored
Merge pull request #218 from totoyoyo/ppp-update
Ppp update
2 parents e883bfd + dbdc1c0 commit 807c893

4 files changed

Lines changed: 18 additions & 31 deletions

File tree

docs/DeveloperGuide.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ The ***Architecture Diagram*** given above explains the high-level design of the
3636

3737
<div markdown="span" class="alert alert-primary">
3838

39-
:bulb: **Tip:** The `.puml` files used to create diagrams in this document can be found in the [diagrams](https://github.com/se-edu/addressbook-level3/tree/master/docs/diagrams/) folder. Refer to the [_PlantUML Tutorial_ at se-edu/guides](https://se-education.org/guides/tutorials/plantUml.html) to learn how to create and edit diagrams.
39+
:bulb: **Tip:** The `.puml` files used to create diagrams in this document can be found in the diagrams folder. Refer to the [_PlantUML Tutorial_ at se-edu/guides](https://se-education.org/guides/tutorials/plantUml.html) to learn how to create and edit diagrams.
4040

4141
</div>
4242

43-
**`Main`** has two classes called [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java). It is responsible for,
43+
**`Main`** has two classes called `Main` and `MainApp`. It is responsible for,
4444
* At app launch: Initializes the components in the correct sequence, and connects them up with each other.
4545
* At shut down: Shuts down the components and invokes cleanup methods where necessary.
4646

@@ -76,12 +76,12 @@ The sections below give more details of each component.
7676
for clarity.](images/UiClassDiagram.png)
7777

7878
**API** :
79-
[`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java)
79+
`Ui.java`
8080

8181
The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PersonListPanel`, `StatusBarFooter` etc.
8282
All these, including the `MainWindow`, inherit from the abstract `UiPart` class.
8383

84-
The `UI` component uses 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)
84+
The `UI` component uses 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` is specified in `MainWindow.fxml`
8585

8686
The `UI` component,
8787

@@ -93,9 +93,9 @@ The `UI` component,
9393
![Structure of the Logic Component](images/LogicClassDiagram.png)
9494

9595
**API** :
96-
[`Logic.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/logic/Logic.java)
96+
`Logic.java`
9797

98-
1. `Logic` uses the `AddressBookParser` class to parse the user command.
98+
1. `Logic` uses the `MeetBuddyParser` class to parse the user command.
9999
1. This results in a `Command` object which is executed by the `LogicManager`.
100100
1. The command execution can affect the `Model` (e.g. adding a person).
101101
1. The result of the command execution is encapsulated as a `CommandResult` object which is passed back to the `Ui`.
@@ -113,7 +113,7 @@ Given below is the Sequence Diagram for interactions within the `Logic` componen
113113

114114
![Structure of the Model Component](images/ModelClassDiagramNew.png)
115115

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

118118
The `Model`,
119119

@@ -122,7 +122,7 @@ The `Model`,
122122
* exposes an unmodifiable `ObservableList<Person>` that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change.
123123
* stores the meeting book data.
124124
* exposes an unmodifiable `ObservableList<Meeting>` that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change.
125-
* stores the connection between the person in the address book and the meeting in the meeting book. e.g. Tom and July both participate in the CS2103 Lecture.
125+
* stores the connection between the person in the contacts book and the meeting in the meeting book. e.g. Tom and July both participate in the CS2103 Lecture.
126126
* does not depend on any of the other three components.
127127
* (Some details are omitted)
128128

@@ -138,7 +138,7 @@ The `Model`,
138138

139139
![Structure of the Storage Component. The full diagram for MeetingBook is omitted to make the figure less cluttered.](images/StorageClassDiagram.png)
140140

141-
**API** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java)
141+
**API** : `Storage.java`
142142

143143
The `Storage` component,
144144
* can save `UserPref` objects in json format and read it back.
@@ -162,7 +162,7 @@ However, there were a few implementations details to consider. The implementatio
162162
discuss the one for contacts.
163163

164164
Currently, an essential attribute in the model are the filtered lists,
165-
which shows the results of searches and finds.
165+
which show the results of searches and finds.
166166
The indexes used in commands like "edit" are taken with respect to these filtered list.
167167
These filtered lists, however, are backed by immutable observable lists,
168168
which helps update the JavaFX GUI. I initially tried to make copies of these observable lists,
@@ -517,18 +517,6 @@ Users would be better able to manage their social and academic commitments by to
517517

518518
Use case ends.
519519

520-
<<<<<<< HEAD
521-
**Use case: Viewing meetings in the timetable**
522-
523-
=======
524-
>>>>>>> 6b3cdedcdc7d066e766ef5f4d6971efdb9916ac1
525-
526-
New features on V1.2
527-
5. Assign priorities to contacts
528-
6. Notes about the contact.
529-
7. Sort contacts by (priorities/personName/groups)
530-
8. Last meetup date for each contact
531-
532520
**Use case: Sort contact list**
533521

534522
**MSS**

src/main/java/seedu/address/logic/commands/meetings/AddMeetingCommand.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ public class AddMeetingCommand extends Command {
3131
+ PREFIX_NAME + "NAME "
3232
+ PREFIX_START_TIME + "START TIME "
3333
+ PREFIX_END_TIME + "END TIME "
34-
+ PREFIX_DESCRIPTION + "DESCRIPTION "
35-
+ PREFIX_PRIORITY + "PRIORITY "
34+
+ "[" + PREFIX_DESCRIPTION + "DESCRIPTION] "
35+
+ "[" + PREFIX_PRIORITY + "PRIORITY] "
3636
+ "[" + PREFIX_GROUP + "GROUP]..."
3737
+ "[" + PREFIX_PERSON_CONNECTION + "INDEX OF PERSON RELATED]...\n"
3838
+ "Example: " + COMMAND_WORD + " "
@@ -131,4 +131,3 @@ public boolean equals(Object other) {
131131
&& toAdd.equals(((AddMeetingCommand) other).toAdd));
132132
}
133133
}
134-

src/main/java/seedu/address/logic/commands/persons/AddPersonCommand.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ public class AddPersonCommand extends Command {
2323
public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to the address book. "
2424
+ "Parameters: "
2525
+ PREFIX_NAME + "NAME "
26-
+ "[" +PREFIX_PHONE + "PHONE] "
27-
+ "[" +PREFIX_EMAIL + "EMAIL] "
28-
+ "[" +PREFIX_ADDRESS + "ADDRESS] "
26+
+ "[" + PREFIX_PHONE + "PHONE] "
27+
+ "[" + PREFIX_EMAIL + "EMAIL] "
28+
+ "[" + PREFIX_ADDRESS + "ADDRESS] "
2929
+ "[" + PREFIX_GROUP + "GROUP]...\n"
3030
+ "Example: " + COMMAND_WORD + " "
3131
+ PREFIX_NAME + "John Doe "

src/main/java/seedu/address/model/person/AddressBook.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
package seedu.address.model.person;
22

3-
import javafx.collections.ObservableList;
4-
import seedu.address.model.group.Group;
3+
import static java.util.Objects.requireNonNull;
54

65
import java.util.HashSet;
76
import java.util.List;
87
import java.util.Set;
98

10-
import static java.util.Objects.requireNonNull;
9+
import javafx.collections.ObservableList;
10+
import seedu.address.model.group.Group;
1111

1212
/**
1313
* Wraps all data at the address-book level

0 commit comments

Comments
 (0)