Merge pull request #12 from rgonslayer/A-CodeQuality

Improve code quality

build.gradle

@@ -49,11 +49,11 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "jarvis.Jarvis"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "jarvis"
     archiveClassifier = null
 }
 

src/main/java/META-INF/MANIFEST.MF

@@ -1,3 +1,3 @@
 Manifest-Version: 1.0
-jarvis.Main-Class: jarvis.Jarvis
+jarvis.GUI.Main-Class: jarvis.Jarvis
 

src/main/java/jarvis/DialogBox.java → src/main/java/jarvis/GUI/DialogBox.java

@@ -1,4 +1,4 @@
-package jarvis;
+package jarvis.GUI;
 
 import java.io.IOException;
 import java.util.Collections;
@@ -58,4 +58,4 @@ public static DialogBox getDukeDialog(String text, Image img) {
         db.flip();
         return db;
     }
-}
+}

src/main/java/jarvis/Main.java → src/main/java/jarvis/GUI/Main.java

@@ -1,7 +1,8 @@
-package jarvis;
+package jarvis.GUI;
 
 import java.io.IOException;
 
+import jarvis.Jarvis;
 import javafx.application.Application;
 import javafx.fxml.FXMLLoader;
 import javafx.scene.Scene;
@@ -28,4 +29,4 @@ public void start(Stage stage) {
             e.printStackTrace();
         }
     }
-}
+}

src/main/java/jarvis/MainWindow.java → src/main/java/jarvis/GUI/MainWindow.java

@@ -1,5 +1,7 @@
-package jarvis;
+package jarvis.GUI;
 
+import jarvis.Jarvis;
+import jarvis.Parser;
 import jarvis.exception.JarvisException;
 import javafx.application.Platform;
 import javafx.fxml.FXML;
@@ -9,6 +11,7 @@
 import javafx.scene.image.Image;
 import javafx.scene.layout.AnchorPane;
 import javafx.scene.layout.VBox;
+
 /**
  * Controller for MainWindow. Provides the layout for the other controls.
  */
@@ -27,6 +30,9 @@ public class MainWindow extends AnchorPane {
     private Image userImage = new Image(this.getClass().getResourceAsStream("/images/user.png"));
     private Image jarvisImage = new Image(this.getClass().getResourceAsStream("/images/jarvis.png"));
 
+    /**
+     * Initialise the scroll window in the UI with introduction message.
+     */
     @FXML
     public void initialize() {
         scrollPane.vvalueProperty().bind(dialogContainer.heightProperty());
@@ -54,4 +60,4 @@ private void handleUserInput() throws JarvisException {
         }
         userInput.clear();
     }
-}
+}

src/main/java/jarvis/Jarvis.java

@@ -1,15 +1,23 @@
 package jarvis;
 
-import jarvis.task.TaskList;
+import java.io.IOException;
+
+import jarvis.GUI.Main;
 import jarvis.exception.JarvisException;
+import jarvis.task.TaskList;
 import javafx.application.Application;
 
-import java.io.IOException;
-
+/**
+ * Jarvis is the main class where the program is initialised.
+ */
+public class Jarvis {
+    private static Parser parser;
 
-public class Jarvis{
-    static Parser parser;
-    public static void main(String[] args){
+    /**
+     * Main method for program
+     * @param args
+     */
+    public static void main(String[] args) {
 
         String filePath = "data/taskList.txt";
 
@@ -34,10 +42,9 @@ public static void main(String[] args){
     }
 
     /**
-     * You should have your own function to generate a response to user input.
-     * Replace this stub with your completed method.
+     * Passes the input to the parser and returns the response
      */
-    String getResponse(String input) throws JarvisException {
+    public String getResponse(String input) throws JarvisException {
         return parser.readCommand(input);
     }