Docs update (#148)

* added AddEventCommand * resolved checkstyle errors * Updated Developer guide v1.2 * Updated Developer Guide v1.2.1 * Updated Developer Guide v1.2.2 * Added DeleteEventCommand * Tried UI * Resolved Checkstyle * Changes * Added Event Storage * resolved checkstyle * resolved checkstyle * UI fixes * minor fixes * checkstyle fixes * Update Model.java * new doc * added EditEventCommand * Updated User Guide * Updated Developer Guide * Updated AboutUs * added PPP * Updated Developer Guide * User Guide minor fixes * checkstyle fixes
CS2113-AY1819S1-T13-1 · Nov 12, 2018 · 0e4c41d · 0e4c41d
1 parent 475cde2
commit 0e4c41d
Show file tree

Hide file tree

Showing 16 changed files with 547 additions and 55 deletions.
diff --git a/docs/AboutUs.adoc b/docs/AboutUs.adoc
@@ -31,7 +31,7 @@ Responsibilities: UI
 
 === Ian Tjahjono
 image::ian-tjahjono.png[width="150", align="left"]
-{empty}[http://github.com/ian-tjahjono[github]]
+{empty}[http://github.com/ian-tjahjono[github]][<<ian-tjahjono#, portfolio>>]
 
 Role: Developer +
 Responsibilities: Data

diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc
@@ -1293,28 +1293,8 @@ Use case ends.
 +
 Use case ends.
 
-//@@author ChenSongJian
-[discrete]
-=== Use case: Add Expense(UC11)
-
-*MSS*
-
-1.  User requests to add an new expense with details
-2.  StudentPlanner adds new expense with given details
-+
-Use case ends.
-
-*Extensions*
-
-[none]
-* 2a. Insufficient or Invalid details provided.
-[none]
-** 2a1. StudentPlanner informs user about unsuccessful adding of expense
-+
-Use case ends.
-//@@
-
-[discrete]
+//@@author ian-tjahjono
+// tag::events[]
 === Use case: Add Event (UC10)
 
 *MSS*
@@ -1336,29 +1316,31 @@ Use case ends.
 ** 2b1. StudentPlanner shows required command format to user. Event is not added.
 +
 Use case ends.
+// end::events[]
+//@@author
 
+//@@author ChenSongJian
 [discrete]
-=== Use case: Add Event (UC10)
+=== Use case: Add Expense(UC11)
 
 *MSS*
 
-1.  User requests to add an event
-2.  StudentPlanner adds new event with given details
+1.  User requests to add an new expense with details
+2.  StudentPlanner adds new expense with given details
 +
 Use case ends.
 
 *Extensions*
 
-* 2a. A similar event exists
 [none]
-** 2a1. StudentPlanner prompts user that a similar event exists. Event is not added.
-+
-Use case ends.
-* 2b. Insufficient or Invalid details provided.
+* 2a. Insufficient or Invalid details provided.
 [none]
-** 2b1. StudentPlanner shows required command format to user. Event is not added.
+** 2a1. StudentPlanner informs user about unsuccessful adding of expense
 +
 Use case ends.
+//@@
+
+[discrete]
 
 _{More to be added}_
 
@@ -1625,3 +1607,48 @@ _{ more test cases ... }_
 .. Test case: Other incorrect monthly expense commands to try: `monthlyExpense`, `monthlyExpense 5/2018` +
    Expected: same as the previous test case
 // end::manualTestMonthlyExpense[]
+
+//@@author ian-tjahjono
+// tag::manualTestEvents[]
+
+=== Adding a new event
+
+. Adding a new event to the event book
+
+.. Prerequisites: The event must not already exist in student planner
+.. Test case: `addEvent n/Watch Avengers 4 movie s/26/05/2018 t/1700 c/John` +
+   Expected: A new event is added to the event book panel, and a success message will show on the results display panel.
+.. Test case: `addEvent n/Watch Avengers 4 movie t/1700 c/John ` +
+   Expected: No event is added and error details will be shown on the result display panel.
+
+=== Deleting an event
+
+. Deletes an event from the event book
+
+.. Prerequisites: The event book must not be empty
+.. Test case: `deleteEvent 1` +
+   Expected: The first event in the event book will be deleted and the first entry on the events panel will disappear.
+.. Test case: `deleteEvent 0` +
+   Expected: No event is deleted and an error message will be displayed on the results display panel.
+.. Test case: (If event book has only 1 event) `deleteEvent 2` +
+   Expected: No event is deleted and an error message will be displayed on the results display panel.
+
+=== Editing an event
+
+. Edits certain parameters of an event
+
+.. Prerequisites: The event book must not be empty
+.. Test case: `editEvent 1 t/1900` +
+   Expected: The time of the first event in the event book will be changed to "1900" and the time of the first event entry in the events panel will be changed to 1900.
+.. Test case: `editEvent 2` +
+   Expected: No event is edited and an error message will be displayed on the results display panel.
+
+=== Clearing an event
+
+. Clears the entire event book
+
+.. Test case: `clearEvent` +
+   Expected: The event book will be cleared and the events panel will not show any entries
+
+// end::manualTestEvents[]
+//@@author
diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc
@@ -1,4 +1,4 @@
-= Student Planner - User Guide
+= Student Planner - User Guide
 :site-section: UserGuide
 :toc:
 :toc-title:
@@ -473,6 +473,71 @@ Deletes the 2nd task from the task book.
 // end::tasks[]
 //@@author
 
+//@@author ian-tjahjono
+// tag::events[]
+=== Adding an event : `addEvent`
+
+Adds an event to the event book +
+Format: `addEvent n/NAME s/EVENT DATE t/EVENT TIME [c/CONTACT]...`
+
+****
+* `NAME` can contain any number of alphanumeric characters and spaces.
+* `DATE` must be of the format DD/MM/YYYY.
+* `TIME` must be 4 digits long in the 24-Hour format, eg. 1030.
+* A new event will be added to the bottom of the event book, and displayed at the bottom of the events panel.
+****
+
+[TIP]
+An event can have any number of contacts (including 0).
+
+Examples:
+* `addEvent n/Dinner s/11/11/2018 t/1900 c/Alex`
+* `addEvent n/Secondary school meetup s/24/10/2018 t/1200 `
+
+=== Deleting an event : `deleteEvent`
+
+Deletes an event from the event book +
+Format: `deleteEvent INDEX`
+
+****
+* Deletes the event at the specified `INDEX`.
+* The index refers to the index number shown in the displayed event list.
+* The index *must be a positive integer* 1, 2, 3, ...
+****
+
+Examples:
+* `deleteEvent 1`
+
+=== Clearing the event book : `clearEvent`
+
+Clears the entire event book +
+Format: `clearEvent`
+
+****
+* Clears the entire event book and creates a new instance of event book with no entries
+****
+
+=== Editing an event : `editEvent`
+
+Edits specific details of the event +
+Format: `editEvent INDEX [n/EVENT NAME] [s/EVENT DATE] [t/EVENT TIME] [c/EVENT CONTACTS]...`
+
+****
+* Edits an event at the specified `INDEX`
+* The index refers to the index number shown in the displayed event list.
+* The index *must be a positive integer* 1, 2, 3, ...
+****
+
+[TIP]
+An edit must consist of at least 1 parameter to edit.
+
+Examples:
+* `editEvent 2 t/1900`
+* `editEvent 1 n/Watch The Incredibles t/1800`
+
+// end::events[]
+//@@author
+
 === Saving the data
 
 Schedule planner data are saved in the hard disk automatically after any command that changes the data. +
@@ -601,4 +666,13 @@ e.g. `updateTask 2`
 * *DeleteTask* : `deleteTask INDEX` +
 e.g. `deleteTask 2 `
 //@@author
-
+//@@author ian-tjahjono
+* *AddEvent* : `addEvent n/NAME s/EVENT DATE t/EVENT TIME [c/EVENT CONTACTS]...` +
+e.g. `addEvent n/Movie s/18/10/2018 t/1800 c/John`
+* *DeleteEvent* : `deleteEvent`
+e.g. `deleteEvent 1`
+* *EditEvent* : `editEvent INDEX [n/NAME] [s/EVENT DATE] [t/EVENT TIME] [c/EVENT CONTACTS]...` +
+e.g. `editEvent 1 t/1800`
+* *ClearEvent* : `clearEvent` +
+e.g. `clearEvent`
+//@@author
diff --git a/docs/team/ian-tjahjono.adoc b/docs/team/ian-tjahjono.adoc
@@ -0,0 +1,49 @@
+= Ian Tjahjono - Project Portfolio
+:site-section: AboutUs
+:imagesDir: ../images
+:stylesDir: ../stylesheets
+
+== Role: Developer
+
+Responsibilities: Developing, testing, events
+
+== PROJECT: Student Planner
+
+---
+
+== Overview
+
+Student Planner is a all-in-one desktop manager application that allows students to manage their contacts, tasks, events and expenses. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+
+== Summary of contributions
+
+* *Major enhancement*: Added *Events management*
+** What it does: Allows the user to manage their events.
+** Justification: This feature allows the user to keep track of new and existing events. Being a student with a busy schedule, he/she may not be able to keep track of all of his/her events, hence this feature will
+help them access their event schedule with just a few commands.
+
+* *Code contributed*: [https://nuscs2113-ay1819s1.github.io/dashboard/#=undefined&search=ian-tjahjono[Overview]]
+
+== Contributions to the User Guide
+
+
+|===
+|_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
+|===
+
+include::../UserGuide.adoc[tag=events]
+
+== Contributions to the Developer Guide
+
+|===
+|_Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._
+|===
+
+include::../DeveloperGuide.adoc[tag=events]
+
+
+**************************************************
+* Note: Manual Testing portion below
+**************************************************
+include::../DeveloperGuide.adoc[tag=manualTestEvents]
+
diff --git a/src/main/java/seedu/address/logic/LogicManager.java b/src/main/java/seedu/address/logic/LogicManager.java
@@ -98,6 +98,7 @@ public ObservableList<Person> getFilteredPersonList() {
     public ObservableList<Event> getFilteredEventList() {
         return model.getFilteredEventList();
     }
+    //@@author
 
     //@@author ChenSongJian
     @Override

diff --git a/src/main/java/seedu/address/logic/commands/AddEventCommand.java b/src/main/java/seedu/address/logic/commands/AddEventCommand.java
@@ -26,9 +26,9 @@ public class AddEventCommand extends Command {
             + "[" + PREFIX_CONTACT + "CONTACT]...\n"
             + "Example: " + COMMAND_WORD + " "
             + PREFIX_NAME + "Watch Avengers 4 movie "
-            + PREFIX_START + "26052019 "
+            + PREFIX_START + "26/05/2018 "
             + PREFIX_TIME + "1700 "
-            + PREFIX_CONTACT + "John";
+            + PREFIX_CONTACT + "John ";
 
     public static final String MESSAGE_SUCCESS = "New event added: %1$s";
     public static final String MESSAGE_DUPLICATE_EVENT = "This event already exists in the task list";