Update JavaDoc

nus-cs2103-AY2324S1 · Sep 10, 2023 · b0af1ec · b0af1ec
1 parent dcc4829
commit b0af1ec
Show file tree

Hide file tree

Showing 6 changed files with 83 additions and 16 deletions.
diff --git a/data/tasks.txt b/data/tasks.txt
@@ -1 +0,0 @@
-0 | test0 | test0 | test

diff --git a/src/main/java/duke/Duke.java b/src/main/java/duke/Duke.java
@@ -4,6 +4,9 @@
 
 import java.io.IOException;
 
+/**
+ * Encapsulates the chat bot.
+ */
 public class Duke {
 
     private Storage storage;
@@ -24,6 +27,9 @@ public Duke(String filePath) {
         }
     }
 
+    /**
+     * Runs the program.
+     */
     public void run() {
         Ui.welcomeMessage();
         Scanner userInput = new Scanner(System.in);

diff --git a/src/main/java/duke/Storage.java b/src/main/java/duke/Storage.java
@@ -11,13 +11,22 @@
 import java.util.ArrayList;
 import java.util.Scanner;
 
+/**
+ * Manages storage of the task list.
+ */
 public class Storage {
-    private final String filePath;
+    private String filePath;
 
     public Storage(String filePath) {
         this.filePath = filePath;
     }
 
+    /**
+     * Loads the task list with file.
+     *
+     * @return The task list.
+     * @throws IOException If unable to gain input from file.
+     */
     public ArrayList<Task> load() throws IOException {
         File dir = new File("./data");
         if (!dir.exists()) {
@@ -28,12 +37,18 @@ public ArrayList<Task> load() throws IOException {
         Scanner s = new Scanner(f);
         ArrayList<Task> tasks = new ArrayList<>();
         while (s.hasNext()) {
-            tasks.add(addTask(s.nextLine()));
+            tasks.add(inputToTask(s.nextLine()));
         }
         return tasks;
     }
 
-    private Task addTask(String input) {
+    /**
+     * Converts the String input to Task.
+
+     * @param input The String input.
+     * @return The corresponding Task.
+     */
+    private Task inputToTask(String input) {
         String taskType = input.split(" \\| ")[0];
         boolean isComplete = input.split(" \\| ")[1].equals("1");
         String description = input.split(" \\| ")[2];
@@ -43,35 +58,47 @@ private Task addTask(String input) {
             LocalDate d = LocalDate.parse(input.split(" \\| ")[3], DateTimeFormatter.ofPattern("MMM dd yyyy", Locale.ENGLISH));
             return new Deadline(description, isComplete, d);
         } else {
-            LocalDate start = LocalDate.parse(input.split(" \\| ")[3], DateTimeFormatter.ofPattern("MMM dd yyyy", Locale.ENGLISH));
-            LocalDate end = LocalDate.parse(input.split(" \\| ")[4], DateTimeFormatter.ofPattern("MMM dd yyyy", Locale.ENGLISH));
+            LocalDate start = LocalDate.parse(input.split(" \\| ")[3],
+                    DateTimeFormatter.ofPattern("MMM dd yyyy", Locale.ENGLISH));
+            LocalDate end = LocalDate.parse(input.split(" \\| ")[4],
+                    DateTimeFormatter.ofPattern("MMM dd yyyy", Locale.ENGLISH));
             return new Event(description, isComplete, start, end);
         }
     }
 
 
-    public void addOneLineToFile(ArrayList<Task> list) throws DukeException {
+    /**
+     * Adds the last task in the task list to file.
+     *
+     * @param list The task list.
+     * @throws DukeException If unable to write to file.
+     */
+    public void addTheLastTaskToFile(ArrayList<Task> list) throws DukeException {
         try {
             FileWriter fw = new FileWriter(filePath, true);
-            if (list.size() == 1) {
-                fw.write(list.get(0).toTxt());
-            } else {
-                fw.write("\n" + list.get(list.size() - 1).toTxt());
+            if (list.size() != 1) {
+                fw.write("\n");
             }
+            fw.write(list.get(list.size() - 1).toTxt());
             fw.close();
         } catch (IOException e) {
             throw new DukeException("Unable to write to file.");
         }
     }
 
+    /**
+     * Rewrites the whole file with the task list.
+     *
+     * @param list The task list.
+     * @throws DukeException If unable to write to file.
+     */
     public void rewriteFile(ArrayList<Task> list) throws DukeException {
         try {
             FileWriter fw = new FileWriter(filePath);
             for (int i = 0; i < list.size(); i++) {
-                if (i == list.size() - 1) {
-                    fw.write(list.get(i).toTxt());
-                } else {
-                    fw.write(list.get(i).toTxt() + "\n");
+                fw.write(list.get(i).toTxt());
+                if (i != list.size() - 1) {
+                    fw.write("\n");
                 }
             }
             fw.close();

diff --git a/src/main/java/duke/TaskList.java b/src/main/java/duke/TaskList.java
@@ -2,6 +2,9 @@
 
 import java.util.ArrayList;
 
+/**
+ * Encapsulates task list in the chat bot.
+ */
 public class TaskList {
     protected ArrayList<Task> tasks;
     private Storage storage;
@@ -16,22 +19,40 @@ public TaskList(ArrayList<Task> tasks, Storage storage) {
         this.storage = storage;
     }
 
+    /**
+     * Lists all tasks in the task list.
+     */
     public void listTasks() {
         Ui.listTasks(this.tasks);
     }
 
+    /**
+     * Adds one task to the task list.
+     *
+     * @param t The task to be added.
+     */
     public void addTask(Task t) {
         this.tasks.add(t);
         Ui.addTask(t, this.tasks);
-        this.storage.addOneLineToFile(this.tasks);
+        this.storage.addTheLastTaskToFile(this.tasks);
     }
 
+    /**
+     * Deletes the task at the specified position in the task list.
+     *
+     * @param num The position starts from 0.
+     */
     public void deleteTask(int num) {
         Task re = tasks.remove(num);
         this.storage.rewriteFile(tasks);
         Ui.deleteTask(re, tasks);
     }
 
+    /**
+     * Marks the task at the specified position in the task list.
+     *
+     * @param num The position starts from 0.
+     */
     public void markTask(int num) {
         Task t = tasks.get(num);
         t.markAsDone();

diff --git a/src/test/java/duke/TaskListTest.java b/src/test/java/duke/TaskListTest.java
@@ -6,7 +6,14 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
+/**
+ * Tests TaskList class.
+ */
 public class TaskListTest {
+
+    /**
+     * Tests addTask function.
+     */
     @Test
     public void addTask() {
         Task t = new Task("test");

diff --git a/src/test/java/duke/TaskTest.java b/src/test/java/duke/TaskTest.java
@@ -4,7 +4,14 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
+/**
+ * Tests task class.
+ */
 public class TaskTest {
+
+    /**
+     * Tests markAsDone function.
+     */
     @Test
     public void markAsDone() {
         Task t = new Task("test", false);