Fix some coding standard and javadoc issues

Author: yunbinmo

src/main/java/spike/Main.java

@@ -13,7 +13,7 @@
  * A GUI for Duke using FXML.
  */
 public class Main extends Application {
-
+    // Initializing the Spike instance
     private Spike spike = new Spike("/data", "/data/Spike.txt");
 
     @Override

src/main/java/spike/Spike.java

@@ -31,7 +31,7 @@ public Spike(String directory, String filePath) {
 
     /**
      * Gets number of tasks.
-     * @return
+     * @return number of tasks
      */
     public int getNumOfTasks() {
         return tasks.getListSize();

src/main/java/spike/command/AddCommand.java

@@ -19,6 +19,12 @@ public AddCommand(Task task) {
         this.task = task;
     }
 
+    /**
+     * Executes the command.
+     *
+     * @param tasks current task list
+     * @return execution result string
+     */
     @Override
     public String execute(TaskList tasks) {
         tasks.addTask(task);

src/main/java/spike/command/DeleteCommand.java

@@ -20,7 +20,7 @@ public DeleteCommand(Task task) {
     }
 
     /**
-     * Removes and printed the deleted task.
+     * Removes and prints the deleted task.
      *
      * @param tasks current task list
      * @return deletion response string
@@ -33,6 +33,8 @@ public String execute(TaskList tasks) {
 
     /**
      * Returns the message needed for printing when deleting task.
+     *
+     * @return response after deleting task
      */
     private String getDeletedTaskText(Task task, TaskList tasks) {
         String result = " Noted. I've removed this task: \n"

src/main/java/spike/command/FindCommand.java

@@ -7,15 +7,15 @@
  * Finds task based on keyword given.
  */
 public class FindCommand extends Command {
-    private String keyWord;
+    private String keyword;
 
     /**
      * Constructor using keyword string.
      *
-     * @param keyWord the word used to find tasks
+     * @param keyword the word used to find tasks
      */
-    public FindCommand(String keyWord) {
-        this.keyWord = keyWord;
+    public FindCommand(String keyword) {
+        this.keyword = keyword;
     }
 
     /**
@@ -29,7 +29,7 @@ public String execute(TaskList tasks) {
         int i = 1;
         String result = "Here are the matching tasks in your list:\n";
         for (Task task : tasks.getTasks()) {
-            if (task.toString().contains(keyWord)) {
+            if (task.toString().contains(keyword)) {
                 result = result + i + "." + task + "\n";
             }
             i++;

src/main/java/spike/command/ListCommand.java

@@ -50,7 +50,7 @@ public String execute(TaskList tasks) {
      * Lists all tasks.
      *
      * @param tasks
-     * @return
+     * @return all tasks
      */
     private String getTaskListText(TaskList tasks) {
         int i = 1;
@@ -62,6 +62,12 @@ private String getTaskListText(TaskList tasks) {
         return result.trim();
     }
 
+    /**
+     * Lists all tasks by date.
+     *
+     * @param tasks
+     * @return all task filtered by date
+     */
     private String getTaskListTextByDate(TaskList tasks) {
         int i = 1;
         String result = "Here are the task(s) in your list filtered by date:\n";

src/main/java/spike/parser/Parser.java

@@ -1,4 +1,5 @@
 package spike.parser;
+
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;
 import java.time.format.DateTimeParseException;
@@ -52,11 +53,14 @@ public String getCommand() {
      * @return a proper command to be executed
      */
     public Command parseCommand(String inputLine, TaskList tasks) {
+        // Extract the words
         String[] commandWords = inputLine.split(" ");
+        // Get the command name and check validity
         CommandName type = validateCommand(commandWords[0]);
         if (type == null) {
             return new IncorrectCommand("Sorry, I am not programmed to do this yet :(");
         }
+        // Start to generate command
         switch (type) {
         case LIST:
             try {
@@ -100,14 +104,27 @@ public Command parseCommand(String inputLine, TaskList tasks) {
         }
     }
 
+    /**
+     * Parses the find command.
+     *
+     * @param inputLine user raw input
+     * @return a command object ready to be executed
+     * @throws SpikeException if the keyword for find is missing
+     */
     private Command parseFind(String inputLine) throws SpikeException {
         if (inputLine.length() <= 5) {
             throw new SpikeException("Kindly enter the keyword for finding task");
         }
         return new FindCommand(inputLine.substring(5));
     }
 
-
+    /**
+     * Parses the list command.
+     *
+     * @param inputLine user raw input
+     * @return a command object ready to be executed
+     * @throws SpikeException if the keyword for list by date is missing
+     */
     private Command parseList(String inputLine) throws SpikeException {
         if (inputLine.length() >= 5) {
             // User tries to list task by date
@@ -122,6 +139,15 @@ private Command parseList(String inputLine) throws SpikeException {
         }
     }
 
+    /**
+     * Parses the add command
+     *
+     * @param c command name
+     * @param command whole command in string
+     * @param commandWords command broken down into words
+     * @return a command object ready to be executed
+     * @throws SpikeException if any parameter is missing
+     */
     private Command parseAdd(CommandName c, String command, String[] commandWords) throws SpikeException {
         DateTimeFormatter dtf = DateTimeFormatter.ofPattern("yyyy-MM-dd HHmm");
         switch (c) {
@@ -163,6 +189,14 @@ private Command parseAdd(CommandName c, String command, String[] commandWords) t
         }
     }
 
+    /**
+     * Parses delete command.
+     *
+     * @param commandWords command broken down into words
+     * @param tasks current task list
+     * @return a command object ready to be executed
+     * @throws SpikeException if any parameter is missing
+     */
     private Command parseDelete(String[] commandWords, TaskList tasks) throws SpikeException {
         if (commandWords.length != 2 || isInt(commandWords[1]) == -1
                 || isInt(commandWords[1]) > tasks.getListSize()) {
@@ -172,6 +206,15 @@ private Command parseDelete(String[] commandWords, TaskList tasks) throws SpikeE
         return new DeleteCommand(toDelete);
     }
 
+    /**
+     * Parses mark or unmark command
+     *
+     * @param c command name
+     * @param commandWords command broken down into words
+     * @param tasks current task list
+     * @return a command object ready to be executed
+     * @throws SpikeException if any parameter is missing
+     */
     private Command parseToggleMark(CommandName c, String[] commandWords, TaskList tasks) throws SpikeException {
         if (c.getCommand().equals("mark")) {
             if (commandWords.length != 2 || isInt(commandWords[1]) == -1
@@ -190,13 +233,20 @@ private Command parseToggleMark(CommandName c, String[] commandWords, TaskList t
         }
     }
 
+    /**
+     * Parses exit command
+     *
+     * @return a command ready to be executed
+     */
     private Command parseExit() {
         return new ExitCommand();
     }
 
 
     /**
      * Parses date and time input by user and returns valid LocalDateTime object
+     *
+     * @return object containing date and time information
      */
     private static LocalDateTime parseDateTime(String s, DateTimeFormatter dtf) {
         try {
@@ -210,6 +260,8 @@ private static LocalDateTime parseDateTime(String s, DateTimeFormatter dtf) {
     /**
      * Checks whether the input string is integer.
      * If yes, return it, else return -1.
+     *
+     * @return indicator of whether the input is an integer
      */
     private static int isInt(String str) {
         try {
@@ -224,6 +276,8 @@ private static int isInt(String str) {
     /**
      * Checks whether it is a valid command.
      * If valid, return that command enum number, else return null.
+     *
+     * @return command name if the input is valid
      */
     private CommandName validateCommand(String input) {
         for (CommandName c : CommandName.values()) {

src/main/java/spike/task/Task.java

@@ -33,6 +33,8 @@ public Task(String description, LocalDateTime dateTime) {
 
     /**
      * Retrieve the task status icon.
+     *
+     * @return status icon
      */
     private String getStatusIcon() {
         return (isDone ? "X" : " "); // mark done task with X
@@ -54,21 +56,26 @@ public void markAsNotDone() {
 
     /**
      * Returns the representative string for saving in data file.
+     *
+     * @return string format for saving
      */
     public String toFileFormat() {
         return "";
     }
 
     /**
-     * Format the string representation of spike.task.Task objects.
      * Gets the date and time for tasks with such information.
+     *
+     * @return object containing the date and time information
      */
     public LocalDateTime getDateTime() {
         return this.dateTime;
     }
 
     /**
-     * Formats the string representation of spike.task.Task objects.
+     * Formats the string representation of Task objects.
+     *
+     * @return string representation of a task
      */
     @Override
     public String toString() {

src/main/java/spike/ui/DialogBox.java

@@ -50,11 +50,14 @@ private void flip() {
     }
 
     public static DialogBox getUserDialog(String text, Image img) {
-        return new DialogBox(text, img);
+        DialogBox dialogBox = new DialogBox(text, img);
+        dialogBox.getChildren().get(0).setStyle("-fx-background-color: #a9a9a9; -fx-background-radius: 10;");
+        return dialogBox;
     }
 
     public static DialogBox getSpikeDialog(String text, Image img) {
         var db = new DialogBox(text, img);
+        db.getChildren().get(0).setStyle("-fx-background-color: #3cb371; -fx-background-radius: 10;");
         db.flip();
         return db;
     }

src/main/java/spike/ui/MainWindow.java

@@ -8,7 +8,6 @@
 import javafx.scene.layout.AnchorPane;
 import javafx.scene.layout.VBox;
 import spike.Spike;
-import spike.command.ExitCommand;
 
 /**
  * Controller for MainWindow. Provides the layout for the other controls.
@@ -67,16 +66,10 @@ public void setSpike(Spike s) {
     private void handleUserInput() {
         String input = userInput.getText();
         String response = spike.getResponseCommand(input);
-        if (response.equals(ExitCommand.EXIT_MESSAGE)) {
-            dialogContainer.getChildren().addAll(
-                    DialogBox.getSpikeDialog(response, spikeImage)
-            );
-        } else {
-            dialogContainer.getChildren().addAll(
-                    DialogBox.getUserDialog(input, userImage),
-                    DialogBox.getSpikeDialog(response, spikeImage)
-            );
-        }
+        dialogContainer.getChildren().addAll(
+                DialogBox.getUserDialog(input, userImage),
+                DialogBox.getSpikeDialog(response, spikeImage)
+        );
         userInput.clear();
     }
 }