[Eugene Ong Wei Xiang] iP

src/main/java/ren/Parser.java

@@ -5,7 +5,7 @@
  */
 public class Parser {
     /**
-     * Interprets user commands ad executes them.
+     * Interprets user commands and executes them.
      *
      * @param cmd Command to execute.
      * @param tasks TaskList to execute commands on.
@@ -55,8 +55,10 @@ public static String parseCommand(String cmd, TaskList tasks) throws RenExceptio
                     : "0";
                 return tasks.deleteTask(Integer.parseInt(secondTerm));
             } catch (NumberFormatException e) {
+                // If the second term parsed isn't an integer
                 throw new RenException("Please indicate the task no. in digits.");
             } catch (RenException f) {
+                // The user entered an invalid number
                 return f.toString();
             }
         case "mark":
@@ -66,8 +68,10 @@ public static String parseCommand(String cmd, TaskList tasks) throws RenExceptio
                     : "0";
                 return tasks.updateTask(true, Integer.parseInt(secondTerm));
             } catch (NumberFormatException e) {
+                // If the second term parsed isn't an integer
                 throw new RenException("Please indicate the task no. in digits.");
             } catch (RenException f) {
+                // The user entered an invalid number
                 return f.toString();
             }
         case "unmark":
@@ -77,8 +81,10 @@ public static String parseCommand(String cmd, TaskList tasks) throws RenExceptio
                     : "0";
                 return tasks.updateTask(false, Integer.parseInt(secondTerm));
             } catch (NumberFormatException e) {
+                // If the second term parsed isn't an integer
                 throw new RenException("Please indicate the task no. in digits.");
             } catch (RenException f) {
+                // The user entered an invalid number
                 return f.toString();
             }
         case "list":

src/main/java/ren/Ren.java

@@ -4,9 +4,10 @@
  * Ren is a Task Manager program that helps a user keep track of and manage their tasks.
  */
 public class Ren {
-    /** Stores the list of tasks added by the user. */
+    /** Stores and manages the list of tasks added by the user. */
     private final TaskList tasks;
 
+    /** Manages the interaction between user and Ren. */
     private final Ui ui = new Ui();
 
     /**
@@ -40,6 +41,9 @@ public static void main(String[] args) {
         new Ren().run();
     }
 
+    /**
+     * The types of Tasks supported by Ren.
+     */
     enum TaskType {
         TODO,
         DEADLINE,

src/main/java/ren/Storage.java

@@ -42,9 +42,13 @@ public Storage(String filePath) {
         init();
     }
 
+    /**
+     * Initialises dataArray using dataFile and creates dataFile if it is missing.
+     */
     private void init() {
         if (!dataFile.exists()) {
             try {
+                // Check if the parent directory exists
                 if (!dataFile.getParentFile().exists()) {
                     dataFile.getParentFile().mkdir();
                 }
@@ -66,6 +70,9 @@ private void init() {
         }
     }
 
+    /**
+     * Resets the File to a blank File.
+     */
     private void newFile() {
         try {
             dataFile.delete();
@@ -75,6 +82,9 @@ private void newFile() {
         }
     }
 
+    /**
+     * Overwrite the File with a new list of Tasks.
+     */
     private void writeToFile() {
         // Disable writing to File if error occurred during creation of file or reading of file.
         if (hasError) {
@@ -94,6 +104,9 @@ private void writeToFile() {
         }
     }
 
+    /**
+     * Append a new Task's information to the File.
+     */
     private void appendToFile() {
         // Disable writing to File if error occurred during creation of file or reading of file.
         if (hasError) {
@@ -123,6 +136,7 @@ private void appendToFile() {
     public ArrayList<Task> load() {
         ArrayList<Task> tasks = new ArrayList<>();
         for (int i = 0; i < this.counter; i++) {
+            // Split the task information into individual terms
             String[] data = dataArray.get(i).split("\\|");
             Task newTask = null;
             switch (data[0]) {

src/main/java/ren/TaskList.java

@@ -7,15 +7,14 @@
 import ren.task.Task;
 import ren.task.Todo;
 
-
 /**
  * TaskList contains a list of Tasks as well methods to add, delete, update tasks.
  */
 public class TaskList {
     /** ArrayList to store all Tasks. */
     private final ArrayList<Task> tasks;
 
-    /** Storage to read and write all Tasks to File. */
+    /** Storage to synchronize all changes with. */
     private final Storage storage;
 
     /**

src/main/java/ren/TimeStamp.java

@@ -22,6 +22,7 @@ private TimeStamp(LocalDateTime timestamp) {
      * @throws RenException If dateTime is not formatted correctly.
      */
     public static TimeStamp of(String dateTime) throws RenException {
+        // format of the date and time information in the input
         DateTimeFormatter format = DateTimeFormatter.ofPattern("d/M/yyyy-H:mm");
         try {
             return new TimeStamp(LocalDateTime.parse(dateTime.strip(), format));
@@ -37,6 +38,7 @@ public static TimeStamp of(String dateTime) throws RenException {
      * @return TimeStamp.
      */
     public static TimeStamp fromFile(String dateTime) {
+        // format of the date and time information in the input
         DateTimeFormatter format = DateTimeFormatter.ofPattern("E, d MMMM yyyy h:mm a");
         try {
             return new TimeStamp(LocalDateTime.parse(dateTime.strip(), format));

src/main/java/ren/Ui.java

@@ -27,7 +27,9 @@ public void greet() {
     }
 
     /**
-     * Say Goodbye to the user.
+     * Returns a Farewell message for the user.
+     *
+     * @return String with the Farewell message.
      */
     public static String goodbye() {
         return " Farewell!\n";

src/main/java/ren/task/Deadline.java

@@ -32,6 +32,7 @@ private Deadline(String description, TimeStamp dateTime) {
      * @return Deadline Task or null if data is corrupted.
      */
     public static Deadline readData(String[] data) {
+        // Check if data is complete
         if (data.length < 4) {
             return null;
         }

src/main/java/ren/task/Event.java

@@ -36,6 +36,7 @@ private Event(String description, TimeStamp start, TimeStamp end) {
      * @return Event or null if data is corrupted.
      */
     public static Event readData(String[] data) {
+        // Check if data is complete
         if (data.length < 5) {
             return null;
         }

src/main/java/ren/task/Todo.java

@@ -20,6 +20,7 @@ public Todo(String description) {
      * @return Todo Task or null if data is corrupted.
      */
     public static Todo readData(String[] data) {
+        // Check if data is complete
         if (data.length < 3) {
             return null;
         }

src/test/java/ren/RenExceptionTest.java

@@ -8,11 +8,11 @@ public class RenExceptionTest {
     @Test
     public void toString_message_success() {
         String message = "Test";
-        assertEquals(" ☹ Apologies! Test\n", new RenException(message).toString());
+        assertEquals(" >_< Apologies! Test\n", new RenException(message).toString());
     }
 
     @Test
     public void toString_empty_success() {
-        assertEquals(" ☹ Apologies! \n", new RenException("").toString());
+        assertEquals(" >_< Apologies! \n", new RenException("").toString());
     }
 }