JavaDoc

src/main/java/Duke/Command.java

@@ -9,10 +9,14 @@
 import java.io.IOException;
 
 public class Command {
-
+    /** The data structure to store all task information**/
     private static ArrayList<Task> tasks = new ArrayList<>();
+    /** The integer to store the sum of tasks**/
     private static int taskSum = 0;
 
+    /**
+     * The methods to print all tasks.
+     */
     public static void printList() {
         Task now;
         System.out.println("     Here are the tasks in your list:");
@@ -22,16 +26,28 @@ public static void printList() {
         }
     }
 
+    /**
+     * The methods to close the system.
+     */
     public static void bye() {
         System.out.println("     Bye. Hope to see you again soon!" );
     }
 
+    /**
+     * The methods to mark the task as done.
+     * @param command A String to store the information of done command.
+     */
     public static void done(String command){
         String[] number = command.split(" ");
         int taskIndex = Integer.parseInt(number[1]) - 1;
         tasks.get(taskIndex).complete();
         System.out.println("     Nice! I've marked this task as done:" + "\n     " +  tasks.get(taskIndex).toString());
     }
+
+    /**
+     * The methods to delete a task from the list.
+     * @param command A String to store the information of delete command.
+     */
     public static void delete(String command){
         String[] number = command.split(" ");
         int taskIndex = Integer.parseInt(number[1]) - 1;
@@ -40,6 +56,11 @@ public static void delete(String command){
         System.out.println("     Noted. I've removed this task: " + "\n     " +  tasks.get(taskIndex).toString() + "\n" + "     Now you have " + taskSum + " tasks in the list");
         tasks.remove(taskIndex);
     }
+
+    /**
+     * The methods to add a todo tyoe into the list.
+     * @param command A String to store the information of todo command.
+     */
     public static void todo(String command){
         int first = command.indexOf(" ");
         String item = command.substring(first,command.length());
@@ -48,6 +69,11 @@ public static void todo(String command){
         taskSum++;
         System.out.println("     Got it. I've added this task: " + "\n" + "       [T][ ] " + item + "\n" + "     Now you have " + taskSum + " tasks in the list");
     }
+
+    /**
+     * The methods to add a deadline tyoe into the list.
+     * @param command A String to store the information of deadline command.
+     */
     public static void deadline(String command){
         int first = command.indexOf(" ");
         int itemEnd = command.indexOf("/");
@@ -59,6 +85,11 @@ public static void deadline(String command){
         System.out.println( "     Got it. I've added this task: " + "\n" + "       [D][ ] " + item + " (" + by + ")" + "\n" + "     Now you have " + taskSum + " tasks in the list");
 
     }
+
+    /**
+     * A String to store the information of event command.
+     * @param command A String to store the information of event command.
+     */
     public static void event(String command){
         int first = command.indexOf(" ");
         int itemEnd = command.indexOf("/");
@@ -69,6 +100,11 @@ public static void event(String command){
         taskSum++;
         System.out.println("     Got it. I've added this task: " + "\n" + "       [E][ ] " + item + " (" + at + ")" + "\n" + "     Now you have " + taskSum + " tasks in the list");
     }
+
+    /**
+     * The methods to find a task by searching for a keyword.
+     * @param command A String to store the information of event command.
+     */
     public static void find(String command){
         System.out.println("     Here are the matching tasks in your list:");
         int first = command.indexOf(" ");
@@ -81,9 +117,19 @@ public static void find(String command){
             }
         }
     }
+
+    /**
+     * The methods means that Duke cannot understand the command.
+     */
     public static void printerror(){
         System.out.println("     ☹ OOPS!!! I'm sorry, but I don't know what that means :-(");
     }
+
+    /**
+     * The methods to write the output into the file.
+     * @param filePath A string store the path of the output file.
+     * @throws IOException Exception strows when cannot find the path of the file.
+     */
     public static void writeToFile(String filePath) throws IOException {
         FileWriter fw = new FileWriter(filePath);
         for(int i=0; i<taskSum; i++){

src/main/java/Duke/Duke.java

@@ -1,16 +1,14 @@
 package Duke;
-
 import java.util.Scanner;
 
 public class Duke {
-
+    
     public static void main(String[] args) {
         Ui.printLogo();
         Ui.greeting();
         String command;
         Scanner in = new Scanner(System.in);
         boolean flag = true;
-
         do{
             command = in.nextLine();
             flag = Parser.parse(command);

src/main/java/Task/Deadline.java

@@ -1,13 +1,23 @@
 package Task;
 
 public class Deadline extends Task {
+    /** The deadline of the task**/
     protected String by;
 
+    /**
+     * A constructor of Deadline.
+     * @param content the name of the task.
+     * @param by the deadline of the task
+     */
     public Deadline(String content, String by) {
         super(content);
         this.by = by;
     }
 
+    /**
+     * A methods to return the whole information of the Deadline
+     * @return A String contains the type, name, and deadline for this task.
+     */
     @Override
     public String toString() {
         return "[D]" + super.toString() + "(" + by + ")";

src/main/java/Task/Event.java

@@ -1,11 +1,23 @@
 package Task;
 
 public class Event extends Task {
+    /** The deadline of the task**/
     protected String at;
+
+    /**
+     * A constructor of Event.
+     * @param content the name of the task.
+     * @param at the deadline of the task.
+     */
     public Event(String content, String at) {
         super(content);
         this.at = at;
     }
+
+    /**
+     * A methods to return the whole information of the Event
+     * @return A String contains the type, name, and deadline for this task.
+     */
     @Override
     public String toString() {
         return "[E]" + super.toString() + "（a" + at + ")";

src/main/java/Task/Task.java

@@ -1,23 +1,37 @@
 package Task;
 
 public class Task {
+    /** The name of the task**/
     protected String content;
+    /** The complement status of the task **/
     protected boolean Done;
 
-
+    /**
+     * A public constructor to initialized the Task.
+     * @param content the whole information of the task
+     */
     public Task(String content) {
         this.content = content;
         this.Done = false;
-
     }
 
+    /**
+     * The methods to mark the task as done.
+     */
     public void complete(){
         this.Done = true;
     }
 
+    /**
+     * @return The complement status of the task.
+     */
     public String getInformation() {
         return (Done ? "X" : " ");
     }
+
+    /**
+     * @return The whole status of teh task including name and complement.
+     */
     @Override
     public String toString() {
         return "[" + getInformation() + "]" + content;

src/main/java/Task/Todo.java

@@ -2,10 +2,18 @@
 
 public class Todo extends Task {
 
+    /**
+     * A public constructor to initialized the Todo.
+     */
     public Todo(String content) {
         super(content);
 
     }
+
+    /**
+     * A methods to return the whole information of the Todo.
+     * @return A String contains the type, and name this task.
+     */
     @Override
     public String toString() {
         return "[T]" + super.toString();