Add more JavaDocs

src/main/java/Duke.java

@@ -33,7 +33,9 @@ public static void main(String[] args) {
         run();
     }
 
-
+    /**
+     * Run the main program and stop when a bye command is given.
+     */
     private static void run() {
         Scanner scanner = new Scanner(System.in);
         Ui.greet();

src/main/java/commands/ByeCommand.java

@@ -1,7 +1,6 @@
 package commands;
 
 import data.TaskList;
-import ui.Ui;
 
 import static common.Message.BYE_MESSAGE;
 
@@ -15,6 +14,7 @@ public class ByeCommand extends Command{
      * Executes the command by printing a bye message.
      *
      * @param tasks runtime storage of tasks.
+     * @return CommandResult that pass printing info to Ui class.
      */
     public CommandResult execute(TaskList tasks) {
         return new CommandResult(BYE_MESSAGE);

src/main/java/commands/Command.java

@@ -10,6 +10,8 @@
 public abstract class Command {
     /**
      * Execute the command.
+     * @throws InvalidTaskNumberException task number out of range.
+     * @throws TaskDoneException done command given to a task that is already done.
      */
     public abstract CommandResult execute(TaskList tasks) throws InvalidTaskNumberException, TaskDoneException;
 }

src/main/java/commands/CommandResult.java

@@ -3,44 +3,92 @@
 import data.TaskList;
 import tasks.Task;
 
+/**
+ * CommandResult represents a result after command execution.
+ * it is pass to Ui class for printing.
+ */
 public class CommandResult {
     private final String message;
     private TaskList tasks = null;
     private Task task = null;
     private int numOfTasks = -1;
 
+    /**
+     * Creates a CommandResult with message, task and number of tasks.
+     *
+     * @param message to be displayed.
+     * @param task that the command operated on, created or deleted.
+     * @param numOfTasks task count after operation.
+     */
     public CommandResult(String message, Task task, int numOfTasks) {
         this.message = message;
         this.task = task;
         this.numOfTasks = numOfTasks;
     }
 
+    /**
+     * Creates a CommandResult with message and task.
+     *
+     * @param message to be displayed.
+     * @param task that the command operated on, created or deleted.
+     */
     public CommandResult(String message, Task task) {
         this.message = message;
         this.task = task;
     }
 
+    /**
+     * Creates a CommandResult with message and tasks.
+     *
+     * @param message to be displayed.
+     * @param tasks to be displayed.
+     */
     public CommandResult(String message, TaskList tasks) {
         this.message = message;
         this.tasks = tasks;
     }
 
+    /**
+     * Creates a CommandResult with message.
+     *
+     * @param message to be displayed.
+     */
     public CommandResult(String message) {
         this.message = message;
     }
 
+    /**
+     * Get the message from CommandResult.
+     *
+     * @return message string.
+     */
     public String getMessage() {
         return message;
     }
 
+    /**
+     * Get the tasks from CommandResult.
+     *
+     * @return a TaskList of tasks.
+     */
     public TaskList getTasks() {
         return tasks;
     }
 
+    /**
+     * Get the task from CommandResult.
+     *
+     * @return a task.
+     */
     public Task getTask() {
         return task;
     }
 
+    /**
+     * Get the task count from CommandResult.
+     *
+     * @return number of tasks.
+     */
     public int getNumOfTasks() {
         return numOfTasks;
     }

src/main/java/commands/DeadlineCommand.java

@@ -24,7 +24,7 @@ public class DeadlineCommand extends Command {
     private final String time;
 
     /**
-     * Creates a AddDeadline Command with trimmed input.
+     * Creates a DeadlineCommand with trimmed input.
      *
      * @param trimmedInput raw input without leading and trailing white space.
      * @throws InvalidCommandException if the trimmed input format does not match with the pattern.
@@ -44,6 +44,7 @@ public DeadlineCommand(String trimmedInput) throws InvalidCommandException {
      * Executes the command by creating a Deadline task and add it to TaskList.
      *
      * @param tasks runtime storage of tasks.
+     * @return CommandResult that pass printing info to Ui class.
      */
     public CommandResult execute(TaskList tasks) {
         Deadline deadline = new Deadline(description, date, time);

src/main/java/commands/DeleteCommand.java

@@ -24,6 +24,7 @@ public class DeleteCommand extends Command{
      * Creates a DeleteCommand with trimmed input.
      *
      * @param trimmedInput raw input without leading and trailing white space.
+     * @throws InvalidCommandException input format does not match with the command word.
      */
     public DeleteCommand(String trimmedInput) throws InvalidCommandException {
         Matcher matcher = COMMAND_PATTERN.matcher(trimmedInput);
@@ -38,6 +39,8 @@ public DeleteCommand(String trimmedInput) throws InvalidCommandException {
      * Executes the command by deleting task of given index.
      *
      * @param tasks runtime storage of tasks.
+     * @return CommandResult that pass printing info to Ui class.
+     * @throws InvalidTaskNumberException task number out of range.
      */
     public CommandResult execute(TaskList tasks) throws InvalidTaskNumberException {
         Task task = tasks.deleteTask(taskNum);

src/main/java/commands/DoneCommand.java

@@ -10,7 +10,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import static common.Message.*;
+import static common.Message.MARK_AS_DONE_MESSAGE;
 
 /**
  * Representation of command that marks a task in TaskList as done.
@@ -24,6 +24,7 @@ public class DoneCommand extends Command{
      * Creates a DoneCommand with trimmed input.
      *
      * @param trimmedInput raw input without leading and trailing white space.
+     * @throws InvalidCommandException input format does not match with the command word.
      */
     public DoneCommand(String trimmedInput) throws InvalidCommandException {
         Matcher matcher = COMMAND_PATTERN.matcher(trimmedInput);
@@ -38,6 +39,8 @@ public DoneCommand(String trimmedInput) throws InvalidCommandException {
      * Executes the command by marking task of given index as done.
      *
      * @param tasks runtime storage of tasks.
+     * @return CommandResult that pass printing info to Ui class.
+     * @throws InvalidTaskNumberException task number out of range.
      */
     public CommandResult execute(TaskList tasks) throws InvalidTaskNumberException, TaskDoneException {
         Task task = tasks.markAsDone(taskNum);

src/main/java/commands/EventCommand.java

@@ -25,7 +25,7 @@ public class EventCommand extends Command {
     private final String end;
 
     /**
-     * Creates a AddEvent Command with trimmed input.
+     * Creates a EventCommand with trimmed input.
      *
      * @param trimmedInput raw input without leading and trailing white space.
      * @throws InvalidCommandException if the trimmed input format does not match with the pattern.
@@ -46,6 +46,7 @@ public EventCommand(String trimmedInput) throws InvalidCommandException {
      * Executes the command by creating a Event task and add it to TaskList.
      *
      * @param tasks runtime storage of tasks.
+     * @return CommandResult that pass printing info to Ui class.
      */
     public CommandResult execute(TaskList tasks) {
         Event event = new Event(description, date, start, end);

src/main/java/commands/FindCommand.java

@@ -8,12 +8,21 @@
 
 import static common.Message.FIND_MESSAGE;
 
+/**
+ * Representation of command that finds relevant task(s) from TaskList.
+ */
 public class FindCommand extends Command {
     public static final String COMMAND_WORD = "find";
     private static final Pattern COMMAND_PATTERN = Pattern.compile(COMMAND_WORD + "(?<keyword>.*\\s.*)");
 
     private final String keyword;
 
+    /**
+     * Creates a FindCommand with trimmed input.
+     *
+     * @param trimmedInput raw input without leading and trailing white space.
+     * @throws InvalidCommandException if the trimmed input format does not match with the pattern.
+     */
     public FindCommand(String trimmedInput) throws InvalidCommandException {
         Matcher matcher = COMMAND_PATTERN.matcher(trimmedInput);
         if (matcher.find()) {
@@ -23,6 +32,12 @@ public FindCommand(String trimmedInput) throws InvalidCommandException {
         }
     }
 
+    /**
+     * Executes the command by searching all tasks in TaskList with given keyword.
+     *
+     * @param tasks runtime storage of tasks.
+     * @return CommandResult that pass printing info to Ui class.
+     */
     public CommandResult execute(TaskList tasks) {
         TaskList filteredTasks = new TaskList();
         for (int i = 0; i < tasks.size(); i++) {

src/main/java/commands/ListCommand.java

@@ -14,6 +14,7 @@ public class ListCommand extends Command{
      * Executes the command by listing all the tasks.
      *
      * @param tasks runtime storage of tasks.
+     * @return CommandResult that pass printing info to Ui class.
      */
     public CommandResult execute(TaskList tasks) {
         return new CommandResult(LIST_MESSAGE, tasks);

src/main/java/commands/TodoCommand.java

@@ -20,9 +20,10 @@ public class TodoCommand extends Command {
     private final String description;
 
     /**
-     * Creates a AddTodo Command with trimmed input.
+     * Creates a TodoCommand with trimmed input.
      *
      * @param trimmedInput raw input without leading and trailing white space.
+     * @throws InvalidCommandException input format does not match with the command word.
      */
     public TodoCommand(String trimmedInput) throws InvalidCommandException {
         Matcher matcher = COMMAND_PATTERN.matcher(trimmedInput);
@@ -37,6 +38,7 @@ public TodoCommand(String trimmedInput) throws InvalidCommandException {
      * Executes the command by creating a Todo task and add it to TaskList.
      *
      * @param tasks runtime storage of tasks.
+     * @return CommandResult that pass printing info to Ui class.
      */
     public CommandResult execute(TaskList tasks) {
         Todo todo = new Todo(description);

src/main/java/common/Message.java

@@ -1,5 +1,8 @@
 package common;
 
+/**
+ * Message class contains messages to be printed by Ui class.
+ */
 public class Message {
     public static final String HORIZONTAL_LINE = "\t______________________________" +
             "______________________________";

src/main/java/common/Utils.java

@@ -6,8 +6,18 @@
 import java.time.LocalTime;
 import java.time.format.DateTimeFormatter;
 
+/**
+ * Utils class contains utility functions used by the program.
+ */
 public class Utils {
 
+
+    /**
+     * Convert a date from String to LocalDate.
+     *
+     * @param dateString String representation of a date.
+     * @return LocalDate that converts from dateString.
+     */
     public static LocalDate dateStringToDate(String dateString) {
         if (dateString == null) {
             return null;
@@ -22,6 +32,12 @@ public static LocalDate dateStringToDate(String dateString) {
         }
     }
 
+    /**
+     * Convert a time from String to LocalDate.
+     *
+     * @param timeString String representation of a time.
+     * @return LocalTime that converts from timeString.
+     */
     public static LocalTime timeStringToTime(String timeString) {
         if (timeString == null) {
             return null;
@@ -32,6 +48,12 @@ public static LocalTime timeStringToTime(String timeString) {
         return LocalTime.of(hour, minute);
     }
 
+    /**
+     * Convert a date from LocalDate to String.
+     *
+     * @param date LocalDate object.
+     * @return Formatted String that converts from LocalDate.
+     */
     public static String dateToString(LocalDate date) {
         if (date == null) {
             return "";
@@ -40,6 +62,12 @@ public static String dateToString(LocalDate date) {
         }
     }
 
+    /**
+     * Convert a time from LocalTime to String.
+     *
+     * @param time LocalTime object.
+     * @return Formatted String that converts from LocalTime.
+     */
     public static String timeToString(LocalTime time) {
         if (time == null) {
             return "";

src/main/java/data/TaskList.java

@@ -41,6 +41,8 @@ public Task get(int index) {
 
     /**
      * Remove task from TaskList using index.
+     *
+     * @return task that is removed from the TaskList.
      */
     public Task deleteTask(int taskNum) throws InvalidTaskNumberException {
         if (taskNum <= 0 || taskNum > tasks.size()) {
@@ -51,6 +53,8 @@ public Task deleteTask(int taskNum) throws InvalidTaskNumberException {
 
     /**
      * Mark task as done using index.
+     *
+     * @return task that is marked as done.
      */
     public Task markAsDone(int taskNum) throws InvalidTaskNumberException, TaskDoneException {
         if (taskNum <= 0 || taskNum > tasks.size()) {

src/main/java/exceptions/InvalidCommandException.java

@@ -1,4 +1,5 @@
 package exceptions;
+
 /**
  * InvalidCommandException is thrown when input format
  * does not match with available commands.

src/main/java/exceptions/InvalidTaskNumberException.java

@@ -1,4 +1,8 @@
 package exceptions;
 
+/**
+ * InvalidTaskNumberException is thrown when task number
+ * is out of range.
+ */
 public class InvalidTaskNumberException extends Exception {
 }

src/main/java/exceptions/TaskDoneException.java

@@ -1,4 +1,8 @@
 package exceptions;
 
+/**
+ * TaskDoneException is thrown when done command is
+ * given to a task that is already done.
+ */
 public class TaskDoneException extends Exception {
 }

src/main/java/exceptions/UnknownDateFormatException.java

@@ -0,0 +1,8 @@
+package exceptions;
+
+/**
+ * UnknownDateFormatException is thrown when input date format
+ * is not recognised.
+ */
+public class UnknownDateFormatException extends Exception {
+}