Merge pull request #6 from rgonslayer/A-Javadoc

A-JaveDoc

Author: rgonslayer

src/main/java/jarvis/Parser.java

@@ -12,10 +12,19 @@ public class Parser {
             + "What can I do for you today?";
     private static String farewell = "Goodbye, have a good day.";
     private TaskList tasks;
+
+    /**
+     * Returns a new Parser object with the given list of tasks.
+     * @param tasks Current list of tasks.
+     */
     public Parser(TaskList tasks) {
         this.tasks = tasks;
     }
 
+    /**
+     * Reads and executes commands given by user.
+     * @throws JarvisException if command entered is not recognised.
+     */
     public void readCommand() throws JarvisException {
         while (true) {
             //receive user input
@@ -113,10 +122,16 @@ public void readCommand() throws JarvisException {
         }
     }
 
+    /**
+     * Prints Introduction message.
+     */
     public void introduction() {
         System.out.println(introduction);
     }
 
+    /**
+     * Prints farewell message.
+     */
     public void farewell() {
         System.out.print(farewell);
     }

src/main/java/jarvis/Storage.java

@@ -10,9 +10,20 @@
 import java.util.Scanner;
 public class Storage {
     private String filePath;
+
+    /**
+     * Return new Storage Object with the specified filePath of data.
+     * @param filePath Specified file path of data stored.
+     */
     public Storage(String filePath) {
         this.filePath = filePath;
     }
+
+    /**
+     * Loads tasks from data file into a task list.
+     * @return List of tasks.
+     * @throws IOException if error occurs when reading file.
+     */
     public List<Task> load() throws IOException {
         File myFile = new File(filePath);
         List<Task> taskList = new ArrayList<>();
@@ -54,6 +65,11 @@ public List<Task> load() throws IOException {
         return taskList;
     }
 
+    /**
+     * Stores task list in data file in given file path.
+     * @param tasks Task List to be stored.
+     * @throws IOException if error occurs when writing to data file.
+     */
     public void write(TaskList tasks) throws IOException {
         File myFile = new File(filePath);
         myFile.createNewFile();

src/main/java/jarvis/task/Deadline.java

@@ -3,14 +3,29 @@
 import java.time.LocalDate;
 import java.time.format.DateTimeFormatter;
 
+/**
+ *  Represents a Deadline which is a subclass of Task.
+ *
+ */
 public class Deadline extends Task{
     public LocalDate by;
 
+    /**
+     * Returns a new Deadline Object with the given description and date.
+     *
+     * @param description Description of the task to be done by deadline.
+     * @param date Date of the Deadline.
+     */
     public Deadline(String description, String date) {
         super(description);
         this.by = LocalDate.parse(date);
     }
 
+    /**
+     * Returns String description of Deadline in the following format:
+     * [D] *Deadline Description* (by: *date*)
+     * @return String description of Deadline.
+     */
     @Override
     public String toString() {
         return "[D]" + super.toString() + " (by: " + by.format(DateTimeFormatter.ofPattern("MMM d yyyy")) + ")";

src/main/java/jarvis/task/Event.java

@@ -3,15 +3,30 @@
 import java.time.LocalDate;
 import java.time.format.DateTimeFormatter;
 
+/**
+ *  Represents an Event which is a subclass of Task.
+ *
+ */
 public class Event extends Task{
 
     public LocalDate at;
 
+    /**
+     * Returns a new Event Object with the given description and date.
+     *
+     * @param description Description of the Event.
+     * @param date Date of the Event.
+     */
     public Event(String description, String date) {
         super(description);
         this.at = LocalDate.parse(date);
     }
 
+    /**
+     * Returns String description of Deadline in the following format:
+     * [E] *Event Description* (at: *date*)
+     * @return String description of Event.
+     */
     @Override
     public String toString() {
         return "[E]" + super.toString() + " (at: " + at.format(DateTimeFormatter.ofPattern("MMM d yyyy")) + ")";

src/main/java/jarvis/task/Task.java

@@ -1,30 +1,51 @@
 package jarvis.task;
 
-public class Task {
+/**
+ * Represents a Task.
+ */
+public abstract class Task {
     public String description;
     public boolean isDone;
 
     public static int count = 0;
 
+    /**
+     * Returns a Task object with the given Description.
+     *
+     * @param description Description of the task.
+     */
     public Task(String description) {
         this.description = description;
         this.isDone = false;
         count++;
 
     }
 
+    /**
+     * Marks the task as done.
+     */
     public void mark(){
         isDone = true;
     }
 
+    /**
+     * Marks the task as not done
+     */
     public void unmark() {
         isDone = false;
     }
 
+    /**
+     * Get done/undone status of task
+     * @return "X" if done, " " if not done
+     */
     public String getStatusIcon() {
         return (isDone ? "X" : " "); // mark done task with X
     }
 
+    /**
+     * @return String description of Task.
+     */
     @Override
     public String toString() {
         return "[" + getStatusIcon() + "] " + this.description;

src/main/java/jarvis/task/TaskList.java

@@ -3,17 +3,31 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Represents a list of Tasks
+ */
 public class TaskList {
     private List<Task> tasks;
 
+    /**
+     * Returns a TaskList object with the given tasks
+     *
+     * @param tasks Initial List of tasks
+     */
     public TaskList(List<Task> tasks) {
         this.tasks = tasks;
     }
 
+    /**
+     * Returns an empty TaskList object
+     */
     public TaskList() {
         this.tasks = new ArrayList<>();
     }
 
+    /**
+     * @return List of tasks
+     */
     public List<Task> getList() {
         return tasks;
     }

src/main/java/jarvis/task/ToDo.java

@@ -1,11 +1,25 @@
 package jarvis.task;
 
+/**
+ *  Represents a ToDo which is a subclass of Task.
+ *
+ */
 public class ToDo extends Task{
 
+    /**
+     * Returns a new Todo Object with the given description.
+     *
+     * @param description Description of the ToDo task.
+     */
     public ToDo(String description) {
         super(description);
     }
 
+    /**
+     * Returns String description of Deadline in the following format:
+     * [T] *ToDo Description*
+     * @return String description of ToDo.
+     */
     @Override
     public String toString() {
         return "[T]" + super.toString();