Merge branch 'branch-A-JavaDoc'

Author: car155

.gitignore

@@ -16,3 +16,4 @@ bin/
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
 /data/*
+/src/main/java/META-INF/

src/main/java/duke/Duke.java

@@ -7,11 +7,19 @@
 import java.io.IOException;
 import java.time.format.DateTimeParseException;
 
+/**
+ * Represents a task manager
+ */
 public class Duke {
     private Storage storage;
     private TaskList tasks;
     private Ui ui;
 
+    /**
+     * Class constructor with specified file path.
+     * 
+     * @param filePath The path to load and save from
+     */
     public Duke(String filePath) {
         ui = new Ui();
         storage = new Storage(filePath);
@@ -25,7 +33,9 @@ public Duke(String filePath) {
             tasks = new TaskList();
         }
     }
-
+    /**
+     * Runs the duke programme.
+     */
     public void run() {
         Command c = new WelcomeCommand();
         c.execute(tasks, ui, storage);

src/main/java/duke/Parser.java

@@ -18,7 +18,18 @@
 import java.time.LocalDate;
 import java.time.format.DateTimeParseException;
 
+/**
+ * Parser for Duke commands
+ */
 public class Parser {
+
+    /**
+     * Parses a string input to the relevent command instruction. 
+     * 
+     * @param input The String to be parsed
+     * @return Command to be executed
+     * @throws DukeException
+     */
     public static Command parse(String input) throws DukeException{
         switch (input) {
         case "bye":

src/main/java/duke/Storage.java

@@ -15,13 +15,28 @@
 import java.time.LocalDate;
 import java.time.format.DateTimeParseException;
 
+/**
+ * Storage for Duke
+ */
 public class Storage {
     private String filePath;
 
+    /**
+     * Construction with specified file path
+     * 
+     * @param filePath the file path to load and save from
+     */
     public Storage(String filePath) {
         this.filePath = filePath;
     }
 
+    /**
+     * Loads task list from the file path given during initialisation
+     * 
+     * @return List of saved tasks
+     * @throws IOException
+     * @throws DateTimeParseException
+     */
     public TaskList load() throws IOException, DateTimeParseException {
         int lastDelimiterIndex = this.filePath.lastIndexOf("/");
         if (lastDelimiterIndex < 0) {
@@ -70,6 +85,12 @@ public TaskList load() throws IOException, DateTimeParseException {
         return memList;
     }
 
+    /**
+     * Stores task list into file path specified during initialisation
+     * 
+     * @param tasks Task list to be saved
+     * @throws IOException
+     */
     public void store(TaskList tasks) throws IOException {
         FileWriter fw = new FileWriter(this.filePath);
 

src/main/java/duke/Ui.java

@@ -2,43 +2,72 @@
 
 import java.util.Scanner;
 
+/**
+ * Interface that handles user inputs and prints programme outputs
+ */
 public class Ui {
     private Scanner sc;
 
+    /**
+     * Constructor
+     */
     public Ui() {
         this.sc = new Scanner(System.in);
     }
 
+    /**
+     * Reads one line of the user input
+     * @return
+     */
     public String readCommand() {
         return this.sc.nextLine().strip();
     }
 
+    /**
+     * Closes the interface. 
+     * Once closed, the Ui will no longer read user inputs
+     */
     public void close() {
         this.sc.close();
     }
 
-    // format for greeting, echo and exit
+    /**
+     * Prints a message in the Duke format
+     * @param message Message to be printed
+     */
     public void printMessage(String message) {
         String newMessage = message.replaceAll("\n", "\n     ");
         System.out.println("    ____________________________________________________________\n\n" + "     " + newMessage
                 + "\n" + "    ____________________________________________________________\n");
     }
 
+    /**
+     * Prints welcome message
+     */
     public void showWelcome() {
         String welcomeMessage = "Hello! I'm Duke\nWhat can I do for you?";
         printMessage(welcomeMessage);
     }
 
+    /**
+     * Prints error for loading save file
+     */
     public void showLoadingError() {
         String loadingErrMessage = "OOPS!!! Was unable to load from save\nStarting a new task list...";
         printMessage(loadingErrMessage);
     }
 
+    /**
+     * Shows error for reading save file
+     */
     public void showReadingError() {
         String loadingErrMessage = "OOPS!!! Was unable to parse save file\nStarting a new task list...";
         printMessage(loadingErrMessage);
     }
 
+    /**
+     * Shows goodbye message
+     */
     public void showGoodbye() {
         String goodbyeMessage = "Bye. Hope to see you again soon!";
         printMessage(goodbyeMessage);

src/main/java/duke/command/AddCommand.java

@@ -6,9 +6,17 @@
 import duke.task.Task;
 import duke.task.TaskList;
 
+/**
+ * Represents a command telling duke to add a task to its task list
+ */
 public class AddCommand implements Command {
     Task taskToAdd;
 
+    /**
+     * Constructor
+     * 
+     * @param task Task to be added
+     */
     public AddCommand(Task task) {
         this.taskToAdd = task;
     }

src/main/java/duke/command/CheckCommand.java

@@ -8,9 +8,16 @@
 
 import java.time.LocalDate;
 
+/**
+ * Represetns a command telling to list all tasks on a specified date
+ */
 public class CheckCommand implements Command{
     private LocalDate date;
 
+    /**
+     * Constructor
+     * @param date Date to check
+     */
     public CheckCommand(LocalDate date) {
         this.date = date;
     }
@@ -19,6 +26,7 @@ public boolean isExit() {
         return false;
     }
 
+    /** */
     public void execute(TaskList tasks, Ui ui, Storage storage) {
         TaskList filteredList = new TaskList();
 

src/main/java/duke/command/Command.java

@@ -5,8 +5,22 @@
 
 import duke.task.TaskList;
 
+/** 
+ * Represents a command to duke
+ */
 public interface Command {
+    /**
+     * Checks if the command is an exit command
+     * @return True if is an exit command, false otherwise
+     */
     public boolean isExit();
 
+    /**
+     * Executes the command
+     * 
+     * @param tasks List of tasks to operate on
+     * @param ui User interface for user interaction
+     * @param storage Storage manager for loading and saving task files
+     */
     public void execute(TaskList tasks, Ui ui, Storage storage);
 }

src/main/java/duke/command/DeleteCommand.java

@@ -7,9 +7,17 @@
 import duke.task.Task;
 import duke.task.TaskList;
 
+/**
+ * Represents a command telling duke to delete a task
+ */
 public class DeleteCommand implements Command {
     private int taskNum;
 
+    /**
+     * Constructor
+     * 
+     * @param taskNum The task number of the task to be deleted
+     */
     public DeleteCommand(int taskNum) {
         this.taskNum = taskNum;
     }

src/main/java/duke/command/DoneCommand.java

@@ -6,9 +6,17 @@
 
 import duke.task.TaskList;
 
+/**
+ * Represents a command telling duke to mark a task as complete
+ */
 public class DoneCommand implements Command {
     private int taskNum;
 
+    /**
+     * Constructor
+     * 
+     * @param taskNum Task number of the task to be marked as complete
+     */
     public DoneCommand(int taskNum) {
         this.taskNum = taskNum;
     }