Merge branch 'master' into branch-A-CodingStandard

src/main/java/duke/Deadline.java

@@ -4,6 +4,10 @@
 import java.time.format.DateTimeFormatter;
 import java.util.Locale;
 
+
+/**
+ * Encapsulates deadline which are Tasks with start and end.
+ */
 public class Deadline extends Task {
     private LocalDate by;
     public Deadline(String description, LocalDate by) {
@@ -22,6 +26,9 @@ public String toString() {
                 + this.by.format(DateTimeFormatter.ofPattern("MMM dd yyyy", Locale.ENGLISH)) + ")";
     }
 
+    /**
+     * Returns a String representation of the task for storage.
+     */
     @Override
     public String toTxt() {
         return "D | " + super.toTxt()

src/main/java/duke/Event.java

@@ -4,6 +4,9 @@
 import java.time.format.DateTimeFormatter;
 import java.util.Locale;
 
+/**
+ * Encapsulates events which are Tasks with start and end.
+ */
 public class Event extends Task{
     private LocalDate startTime;
     private LocalDate endTime;
@@ -25,6 +28,9 @@ public String toString() {
                 + " to: " + endTime.format(DateTimeFormatter.ofPattern("MMM dd yyyy", Locale.ENGLISH)) + ")";
     }
 
+    /**
+     * Returns a String representation of the task for storage.
+     */
     @Override
     public String toTxt() {
         return "E | " + super.toTxt() + " | " + this.startTime.format(DateTimeFormatter.ofPattern("MMM dd yyyy", Locale.ENGLISH))

src/main/java/duke/Parser.java

@@ -2,6 +2,9 @@
 
 import java.time.LocalDate;
 
+/**
+ * Parses the user input.
+ */
 public class Parser {
     private String command;
     private Storage storage;
@@ -14,6 +17,9 @@ public Parser(String command, Storage storage, TaskList taskList) {
         this.taskList = taskList;
     }
 
+    /**
+     * Parses the user input and initiate following operations.
+     */
     public void parse() {
         try{
             if (command.startsWith("list")) {
@@ -51,6 +57,9 @@ public void parse() {
         }
     }
 
+    /**
+     * Returns if the parser is ended.
+     */
     public boolean isEnd() {
         return this.isEnd;
     }

src/main/java/duke/Task.java

@@ -1,9 +1,17 @@
 package duke;
 
+/**
+ * Encapsulates tasks for the chatbot.
+ */
 public class Task {
     protected String description;
     protected boolean isDone;
 
+    /**
+     * Constructs a new Task object.
+     *
+     * @param description Description of the task.
+     */
     public Task(String description) {
         this.description = description;
         this.isDone = false;
@@ -14,10 +22,17 @@ public Task(String description, boolean isDone) {
         this.isDone = isDone;
     }
 
+    /**
+     * Gets the status Icon of the Task.
+     */
     public String getStatusIcon() {
-        return (isDone ? "X" : " "); // mark done task with X
+        // X for done task
+        return (isDone ? "X" : " ");
     }
 
+    /**
+     * Marks the task as done.
+     */
     public void markAsDone() {
         this.isDone = true;
     }
@@ -27,6 +42,9 @@ public String toString() {
         return "[" + this.getStatusIcon() + "] " + this.description;
     }
 
+    /**
+     * Returns a String representation of the task for storage.
+     */
     public String toTxt() {
         return (this.isDone ? "1" : "0") + " | " + this.description;
     }

src/main/java/duke/ToDo.java

@@ -1,5 +1,8 @@
 package duke;
 
+/**
+ * Encapsulates todos which are Tasks.
+ */
 public class ToDo extends Task {
     public ToDo(String description) {
         super(description);
@@ -14,6 +17,9 @@ public String toString() {
         return "[T]" + super.toString();
     }
 
+    /**
+     * Returns a String representation of the task for storage.
+     */
     @Override
     public String toTxt() {
         return "T | " + super.toTxt();