[Eugene Ong Wei Xiang] iP

src/main/java/Deadline.java

@@ -1,6 +1,15 @@
+/**
+ * Deadline Task represents an action that needs to be done by a certain date or time.
+ */
 public class Deadline extends Task {
     protected String dateTime;
 
+    /**
+     * Constructor for a Deadline Task.
+     *
+     * @param description the description of the Task
+     * @param dateTime the deadline of the Task
+     */
     public Deadline(String description, String dateTime) {
         super(description);
         this.dateTime = dateTime;

src/main/java/Duke.java

@@ -1,6 +1,9 @@
 import java.util.ArrayList;
 import java.util.Scanner;
 
+/**
+ * Duke is a Task Manager program that helps a user keep track of and manager their tasks.
+ */
 public class Duke {
     /**
      * Takes in commands entered by the user.
@@ -18,17 +21,6 @@ public class Duke {
      */
     private static int pointer = 0;
 
-    enum TaskType {
-        TODO,
-        DEADLINE,
-        EVENT
-    }
-
-    enum TaskFunc {
-        MARK,
-        UNMARK
-    }
-
     private static void speak(String message) {
         System.out.println("============================================================\n");
         System.out.println(message);
@@ -46,31 +38,31 @@ private static void goodbye() {
     private static void addTask(TaskType type, String task, String dateTime) {
         Task newTask;
         switch (type) {
-            case TODO:
-                newTask = new Todo(task);
-                break;
-            case DEADLINE:
-                newTask = new Deadline(task, dateTime);
-                break;
-            case EVENT:
-                newTask = new Event(task, dateTime);
-                break;
-            default:
-                newTask = new Task(task);
+        case TODO:
+            newTask = new Todo(task);
+            break;
+        case DEADLINE:
+            newTask = new Deadline(task, dateTime);
+            break;
+        case EVENT:
+            newTask = new Event(task, dateTime);
+            break;
+        default:
+            newTask = new Task(task);
         }
         tasks.add(newTask);
         pointer++;
-        speak(" Understood. I have added the following task:\n" +
-                "   " + newTask +
-                " You have a total of " + pointer + " task(s).\n");
+        speak(" Understood. I have added the following task:\n"
+            + "   " + newTask
+            + " You have a total of " + pointer + " task(s).\n");
     }
 
     private static void deleteTask(int taskNum) throws DukeException {
         if (taskNum <= pointer && taskNum > 0) {
             pointer--;
-            speak(" Understood. I have removed the following task:\n" +
-                    "   " + tasks.get(taskNum - 1) +
-                    " You have a total of " + pointer + " task(s).\n");
+            speak(" Understood. I have removed the following task:\n"
+                + "   " + tasks.get(taskNum - 1)
+                + " You have a total of " + pointer + " task(s).\n");
             tasks.remove(taskNum - 1);
         } else {
             throw new DukeException("Please indicate a task no. between 1 to " + pointer + ".");
@@ -80,12 +72,13 @@ private static void deleteTask(int taskNum) throws DukeException {
     private static void updateTask(TaskFunc func, int taskNum) throws DukeException {
         if (taskNum <= pointer && taskNum > 0) {
             switch (func) {
-                case MARK:
-                    speak(tasks.get(taskNum - 1).mark());
-                    break;
-                case UNMARK:
-                    speak(tasks.get(taskNum - 1).unmark());
-                    break;
+            case MARK:
+                speak(tasks.get(taskNum - 1).mark());
+                break;
+            case UNMARK:
+                speak(tasks.get(taskNum - 1).unmark());
+                break;
+            default:
             }
         } else {
             throw new DukeException("Please indicate a task no. between 1 to " + pointer + ".");
@@ -116,90 +109,93 @@ private static void parseCommand(String cmd) throws DukeException {
         boolean hasSecondTerm = firstParse.length > 1;
 
         switch (firstTerm) {
-            case "bye":
-                goodbye();
+        case "bye":
+            goodbye();
+            break;
+        case "todo":
+            if (hasSecondTerm) {
+                addTask(TaskType.TODO, firstParse[1], "");
                 break;
-            case "todo":
-                if (hasSecondTerm) {
-                    addTask(TaskType.TODO, firstParse[1], "");
+            } else {
+                throw new DukeException("Please provide a description for the todo.");
+            }
+        case "deadline":
+            if (hasSecondTerm) {
+                String[] secondParse = firstParse[1].split("/by", 2);
+                if (secondParse.length > 1) {
+                    addTask(TaskType.DEADLINE, secondParse[0], secondParse[1]);
                     break;
                 } else {
-                    throw new DukeException("Please provide a description for the todo.");
-                }
-            case "deadline":
-                if (hasSecondTerm) {
-                    String[] secondParse = firstParse[1].split("/by", 2);
-                    if (secondParse.length > 1) {
-                        addTask(TaskType.DEADLINE, secondParse[0], secondParse[1]);
-                        break;
-                    } else {
-                        throw new DukeException("Please provide a date/time for the deadline.");
-                    }
-                } else {
-                    throw new DukeException("Please provide a description for the deadline.");
+                    throw new DukeException("Please provide a date/time for the deadline.");
                 }
-            case "event":
-                if (hasSecondTerm) {
-                    String[] secondParse = firstParse[1].split("/at", 2);
-                    if (secondParse.length > 1) {
-                        addTask(TaskType.EVENT, secondParse[0], secondParse[1]);
-                        break;
-                    } else {
-                        throw new DukeException("Please provide a date/time for the event.");
-                    }
-                } else {
-                    throw new DukeException("Please provide a description for the event.");
-                }
-            case "delete":
-                try {
-                    String secondTerm = hasSecondTerm
-                            ? firstParse[1].split(" ", 2)[0]
-                            : "0";
-                    deleteTask(Integer.parseInt(secondTerm));
-                    break;
-                } catch (NumberFormatException e) {
-                    throw new DukeException("Please indicate the task no. in digits.");
-                } catch (DukeException f) {
-                    speak(f.toString());
-                    break;
-                }
-            case "mark":
-                try {
-                    String secondTerm = hasSecondTerm
-                            ? firstParse[1].split(" ", 2)[0]
-                            : "0";
-                    updateTask(TaskFunc.MARK, Integer.parseInt(secondTerm));
-                    break;
-                } catch (NumberFormatException e) {
-                    throw new DukeException("Please indicate the task no. in digits.");
-                } catch (DukeException f) {
-                    speak(f.toString());
-                    break;
-                }
-            case "unmark":
-                try {
-                    String secondTerm = hasSecondTerm
-                            ? firstParse[1].split(" ", 2)[0]
-                            : "0";
-                    updateTask(TaskFunc.UNMARK, Integer.parseInt(secondTerm));
-                    break;
-                } catch (NumberFormatException e) {
-                    throw new DukeException("Please indicate the task no. in digits.");
-                } catch (DukeException f) {
-                    speak(f.toString());
+            } else {
+                throw new DukeException("Please provide a description for the deadline.");
+            }
+        case "event":
+            if (hasSecondTerm) {
+                String[] secondParse = firstParse[1].split("/at", 2);
+                if (secondParse.length > 1) {
+                    addTask(TaskType.EVENT, secondParse[0], secondParse[1]);
                     break;
+                } else {
+                    throw new DukeException("Please provide a date/time for the event.");
                 }
-            case "list":
-                listTasks();
+            } else {
+                throw new DukeException("Please provide a description for the event.");
+            }
+        case "delete":
+            try {
+                String secondTerm = hasSecondTerm
+                    ? firstParse[1].split(" ", 2)[0]
+                    : "0";
+                deleteTask(Integer.parseInt(secondTerm));
                 break;
-            case "empty":
-                emptyList();
+            } catch (NumberFormatException e) {
+                throw new DukeException("Please indicate the task no. in digits.");
+            } catch (DukeException f) {
+                speak(f.toString());
                 break;
-            default:
-                throw new DukeException("Please enter a supported command.");
+            }
+        case "mark":
+            try {
+                String secondTerm = hasSecondTerm
+                    ? firstParse[1].split(" ", 2)[0]
+                    : "0";
+                updateTask(TaskFunc.MARK, Integer.parseInt(secondTerm));
+                break;
+            } catch (NumberFormatException e) {
+                throw new DukeException("Please indicate the task no. in digits.");
+            } catch (DukeException f) {
+                speak(f.toString());
+                break;
+            }
+        case "unmark":
+            try {
+                String secondTerm = hasSecondTerm
+                    ? firstParse[1].split(" ", 2)[0]
+                    : "0";
+                updateTask(TaskFunc.UNMARK, Integer.parseInt(secondTerm));
+                break;
+            } catch (NumberFormatException e) {
+                throw new DukeException("Please indicate the task no. in digits.");
+            } catch (DukeException f) {
+                speak(f.toString());
+                break;
+            }
+        case "list":
+            listTasks();
+            break;
+        case "empty":
+            emptyList();
+            break;
+        default:
+            throw new DukeException("Please enter a supported command.");
         }
     }
 
+    /**
+     * Runs the Duke program until the user exits with the 'bye' command.
+     */
     public static void main(String[] args) {
         greet();
 
@@ -214,4 +210,15 @@ public static void main(String[] args) {
             }
         }
     }
+
+    enum TaskType {
+        TODO,
+        DEADLINE,
+        EVENT
+    }
+
+    enum TaskFunc {
+        MARK,
+        UNMARK
+    }
 }

src/main/java/DukeException.java

@@ -1,10 +1,13 @@
+/**
+ * DukeExceptions represent errors in user input when using Alfred.
+ */
 public class DukeException extends Exception {
     public DukeException(String message) {
         super(message);
     }
 
     @Override
     public String toString() {
-        return " ☹ Apologies! "+ super.getMessage() + "\n";
+        return " ☹ Apologies! " + super.getMessage() + "\n";
     }
 }

src/main/java/Event.java

@@ -1,6 +1,15 @@
+/**
+ * Event Task represents an event that takes place between certain dates/time.
+ */
 public class Event extends Task {
     protected String dateTime;
 
+    /**
+     * Constructor for an Event Task.
+     *
+     * @param description the description of the Event
+     * @param dateTime the start and end dates/time of the Event
+     */
     public Event(String description, String dateTime) {
         super(description);
         this.dateTime = dateTime;

src/main/java/Task.java

@@ -1,22 +1,40 @@
+/**
+ * Parent Class for all Tasks.
+ */
 public class Task {
     protected String description;
     protected boolean isDone;
 
+    /**
+     * Constructor for a Task.
+     *
+     * @param description the description of the Task
+     */
     public Task(String description) {
         this.description = description;
         this.isDone = false;
     }
 
+    /**
+     * Sets the Task as completed.
+     *
+     * @return string containing the completed message, to be displayed to the user
+     */
     public String mark() {
         this.isDone = true;
-        return " Great job! I will mark the task as completed.\n" +
-                "   " + this;
+        return " Great job! I will mark the task as completed.\n"
+            + "   " + this;
     }
 
+    /**
+     * Sets the Task as uncompleted.
+     *
+     * @return string containing the uncompleted message, to be displayed to the user
+     */
     public String unmark() {
         this.isDone = false;
-        return " Understood. I will mark the task as uncompleted.\n" +
-                "   " + this;
+        return " Understood. I will mark the task as uncompleted.\n"
+            + "   " + this;
     }
 
     @Override

src/main/java/Todo.java

@@ -1,3 +1,6 @@
+/**
+ * Todo Task represents an action that needs to be done.
+ */
 public class Todo extends Task {
     public Todo(String description) {
         super(description);