Merge pull request #2 from NicholasChungJunJie/branch-A-JavaDoc

Add JavaDoc comments

src/main/java/Command.java

@@ -1,3 +1,6 @@
+/**
+ * Represents a command handler to execute user inputs.
+ */
 public class Command {
 
     private String typeOfCommand;
@@ -13,6 +16,13 @@ public Command(String[] inputs) {
         }
     }
 
+    /**
+     * Executes the user command based on user input.
+     *
+     * @param taskList class to store list of tasks at run time.
+     * @param ui Ui class for interaction with user.
+     * @param storage class for loading and saving of tasks to memory.
+     */
     public void execute(TaskList taskList, Ui ui, Storage storage) {
         switch (typeOfCommand) {
             case "list":

src/main/java/Deadline.java

@@ -1,3 +1,6 @@
+/**
+ * Represents a type of task with a deadline.
+ */
 public class Deadline extends Task {
 
     protected String by;
@@ -6,22 +9,42 @@ public Deadline(String description, String by) {
         this.by = by;
     }
 
+    /**
+     * Returns the letter denoting the type of task.
+     *
+     * @return "D" denoting deadline.
+     */
     @Override
     public String getTypeOfTask() {
         return "D";
     }
 
+    /**
+     * Returns the formatted string to be displayed to user without prepended information.
+     *
+     * @return formatted deadline information for user.
+     */
     @Override
     public String getDescription() {
         return super.getDescription() + " (by: " + this.by + ")";
     }
 
+    /**
+     * Returns the formatted string to be saved in duke.txt.
+     *
+     * @return formatted deadline information.
+     */
     @Override
-
     public String getDetailsToSave() {
         return super.description + " /by " + this.by;
     }
 
+    /**
+     * Returns the formatted string to be displayed to user.
+     *
+     * @return formatted deadline information for user.
+     */
+    @Override
     public String toString() {
         return "       [D][ ] " + super.description + " (by: " + this.by + ")";
     }

src/main/java/Duke.java

@@ -4,6 +4,10 @@
 import java.io.IOException;
 import java.io.FileNotFoundException;
 import java.util.ArrayList;
+
+/**
+ * Represents a Personal Assistant Chat bot that helps a person to keep track of various things.
+ */
 public class Duke {
 
     private Ui ui;
@@ -13,9 +17,15 @@ public class Duke {
     private final String FILE_PATH = "data/duke.txt";
     private final String DIR_PATH = "data";
     private final String BYE = "bye";
+
     public static void main(String[] args) {
         new Duke().run();
     }
+
+    /**
+     * Initializes the task list to store tasks, ui for interaction with user,
+     * and storage to store information in duke.txt file.
+     */
     public Duke() {
         ui = new Ui();
         storage = new Storage(DIR_PATH, FILE_PATH);
@@ -28,6 +38,10 @@ public Duke() {
         }
     }
 
+    /**
+     * Represents the main run time function interacting with user.
+     * Sends input from user to the respective classes for execution.
+     */
     public void run() {
 
         ui.printLogo();

src/main/java/DukeException.java

@@ -1,3 +1,6 @@
+/**
+ * Represents the custom exception class for Duke.
+ */
 public class DukeException extends Exception {
 
     public DukeException(String message) {

src/main/java/Event.java

@@ -1,3 +1,6 @@
+/**
+ * Represents a type of task with a start time and an end time.
+ */
 public class Event extends Task {
 
     protected String startTime;
@@ -9,21 +12,41 @@ public Event(String description, String startTime, String endTime) {
         this.endTime = endTime;
     }
 
+    /**
+     * Returns the letter denoting the type of task.
+     *
+     * @return "E" denoting Event.
+     */
     @Override
     public String getTypeOfTask() {
         return "E";
     }
 
+    /**
+     * Returns the formatted string to be displayed to user without prepended information.
+     *
+     * @return formatted event information for user.
+     */
     @Override
     public String getDescription() {
         return super.getDescription() + " (from: " + this.startTime + " to: " + this.endTime + ")";
     }
 
+    /**
+     * Returns the formatted string to be saved in duke.txt.
+     *
+     * @return formatted event information.
+     */
     @Override
     public String getDetailsToSave() {
         return super.description + " /from " + this.startTime + " /to " + this.endTime;
     }
 
+    /**
+     * Returns the formatted string to be displayed to user.
+     *
+     * @return formatted event information for user.
+     */
     public String toString() {
         return "       [E][ ] " + super.getDescription() + " (from: " + this.startTime + " to: " + this.endTime + ")";
     }

src/main/java/Parser.java

@@ -1,5 +1,13 @@
+/**
+ * Represents a parser to parse user input for execution.
+ */
 public class Parser {
 
+    /**
+     * Returns the command and arguments from user input.
+     *
+     * @return c The parsed command from user input
+     */
     public static Command parseInput(String action) {
         Command c = new Command(action.split(" ", 2));
 

src/main/java/Storage.java

@@ -5,6 +5,9 @@
 import java.io.FileNotFoundException;
 import java.util.ArrayList;
 
+/**
+ * Represents the memory to store tasks.
+ */
 public class Storage {
 
     private String dirPath;
@@ -15,6 +18,12 @@ public Storage(String dirPath, String filePath) {
         this.filePath = filePath;
     }
 
+    /**
+     * Calls private function to save list of tasks to memory.
+     *
+     * @param taskList class to store list of tasks at run time.
+     * @param ui Ui class for interaction with user.
+     */
     public void save(TaskList taskList, Ui ui) {
         try {
             saveTasks(taskList.tasks, filePath);
@@ -23,6 +32,13 @@ public void save(TaskList taskList, Ui ui) {
         }
     }
 
+    /**
+     * Saves list of tasks to memory.
+     *
+     * @param tasks The array of tasks.
+     * @param filePath The path to file to store tasks.
+     * @throws IOException If file is not writable.
+     */
     private void saveTasks(ArrayList<Task> tasks, String filePath) throws IOException {
         FileWriter fw = new FileWriter(filePath);
 
@@ -32,6 +48,12 @@ private void saveTasks(ArrayList<Task> tasks, String filePath) throws IOExceptio
         fw.close();
     }
 
+    /**
+     * Calls private function to load list of tasks from memory.
+     *
+     * @throws DukeException If file is cannot be created or found.
+     * @return TaskList Class containing the list of tasks.
+     */
     public TaskList load() throws DukeException {
         TaskList taskList = new TaskList();
         taskList.isSilent = true;
@@ -55,6 +77,14 @@ public TaskList load() throws DukeException {
         return taskList;
     }
 
+    /**
+     * Loads list of tasks to memory.
+     *
+     * @param taskList class to store list of tasks at run time.
+     * @param filePath The path to file to store tasks.
+     * @throws FileNotFoundException If file is not found.
+     * @return TaskList Class containing the list of tasks.
+     */
     private TaskList loadTasks(TaskList taskList , String filePath) throws FileNotFoundException {
         File f = new File(filePath);
         Scanner s = new Scanner(f); // create a Scanner using the File as the source

src/main/java/Task.java

@@ -1,3 +1,6 @@
+/**
+ * Represents a task.
+ */
 public class Task {
     protected String description;
     protected boolean isDone;
@@ -7,11 +10,15 @@ public Task(String description) {
         this.isDone = false;
     }
 
+    /**
+     * Returns an icon indicating if a task is done.
+     *
+     * @return X if done
+     */
     public String getStatusIcon() {
         return (isDone ? "X" : " "); // mark done task with X
     }
 
-    //...
     public String getDescription() {
         return this.description;
     }

src/main/java/TaskList.java

@@ -1,5 +1,8 @@
 import java.util.ArrayList;
 
+/**
+ * Represents the list of task.
+ */
 public class TaskList {
 
     protected ArrayList<Task> tasks;
@@ -12,6 +15,9 @@ public TaskList(ArrayList<Task> tasks) throws DukeException{
         this.tasks = tasks;
     }
 
+    /**
+     * Lists all tasks.
+     */
     public void listTask() {
         System.out.println("     Here are the tasks in your list:\n");
         for (int i = 0; i < tasks.size(); i = i + 1) {
@@ -23,6 +29,12 @@ public void listTask() {
         }
     }
 
+    /**
+     * Marks specified task as done if taskNumber parameter is an integer.
+     *
+     * @param taskNumber The 1th-index of task to be marked.
+     * @throws DukeException If taskNumber is out of bounds.
+     */
     public void markTask(int taskNumber) throws DukeException {
 
         int ind = taskNumber - 1;
@@ -42,6 +54,12 @@ public void markTask(int taskNumber) throws DukeException {
 
     }
 
+    /**
+     * Marks specified task as done if taskNumber parameter is a string.
+     *
+     * @param taskNumber The 1th-index of task to be marked.
+     * @throws DukeException If taskNumber is out of bounds.
+     */
     public void markTask(String taskNumber) throws DukeException {
         int ind;
         try {
@@ -66,6 +84,12 @@ public void markTask(String taskNumber) throws DukeException {
 
     }
 
+    /**
+     * Marks specified task as not done.
+     *
+     * @param taskNumber The 1th-index of task to be marked.
+     * @throws DukeException If taskNumber is out of bounds.
+     */
     public void unmarkTask(String taskNumber) throws DukeException {
 
         int ind;
@@ -90,6 +114,11 @@ public void unmarkTask(String taskNumber) throws DukeException {
 
     }
 
+    /**
+     * Adds a todo task.
+     *
+     * @param todoTask The task to be added.
+     */
     public void addTodo(String todoTask) throws DukeException {
 
         tasks.add(new Todo(todoTask));
@@ -104,6 +133,12 @@ public void addTodo(String todoTask) throws DukeException {
 
     }
 
+    /**
+     * Adds a deadline task.
+     *
+     * @param todoTask The task to be added.
+     * @throws DukeException If incorrect arguments are provided.
+     */
     public void addDeadline(String todoTask) throws DukeException {
 
         String[] taskAndDeadline = todoTask.split(" /by ");
@@ -126,6 +161,12 @@ public void addDeadline(String todoTask) throws DukeException {
 
     }
 
+    /**
+     * Adds an event task.
+     *
+     * @param todoTask The task to be added.
+     * @throws DukeException If incorrect arguments are provided.
+     */
     public void addEvent(String todoTask) throws DukeException {
 
         String[] taskAndDeadline = todoTask.split(" /from ");
@@ -156,6 +197,12 @@ public void addEvent(String todoTask) throws DukeException {
 
     }
 
+    /**
+     * Deletes a specified task.
+     *
+     * @param input The 1-th index of the task to be deleted.
+     * @throws DukeException If incorrect arguments are provided or task index is out of bounds.
+     */
     public void deleteTask(String input) throws DukeException {
         int val;
         try {
@@ -179,6 +226,12 @@ public void deleteTask(String input) throws DukeException {
 
     }
 
+    /**
+     * Finds all tasks containing a keyword and prints them with its respective 1th-index number.
+     *
+     * @param keyword The keywords to be found.
+     * @param ui Ui class for interaction with user.
+     */
     public void find(String keyword, Ui ui) throws DukeException {
         System.out.println("     Here are the matching tasks in your list:");
         for(int i = 0; i< tasks.size(); i++) {