Merge pull request nus-cs2113-AY2324S1#10 from AY2324S1-CS2113-F11-3/master

Update

Author: Cheezeblokz

src/main/java/seedu/duke/Duke.java

@@ -1,4 +1,4 @@
-//@@author wendelinwemhoener & bayasgalankherlen
+//@@author wendelinwemhoener
 
 package seedu.duke;
 

src/main/java/seedu/duke/flashcard/Flashcard.java

@@ -2,16 +2,24 @@
 
 package seedu.duke.flashcard;
 
-import java.time.LocalDateTime;
-import java.util.ArrayList;
-
+/**
+ * Represents a flashcard with its associated front and back text as well as
+ * its id and current difficulty.
+ */
 public class Flashcard {
     private static int globalMaxId = 1;
     private String frontText;
     private String backText;
     private int id;
     private int difficulty;
 
+    /**
+     * Instantiates and returns a flashcard with the given front and back text.
+     * Its id and difficulty (which is 5) are automatically set.
+     *
+     * @param frontText The text on the front of the flashcard.
+     * @param backText The text on the back of the flashcard.
+     */
     public Flashcard(String frontText, String backText) {
         this.frontText = frontText;
         this.backText = backText;
@@ -22,7 +30,13 @@ public Flashcard(String frontText, String backText) {
         id = globalMaxId;
     }
 
-    public static void calculateAndUpdateGlobalMaxId(FlashcardList flashcardList) {
+    /**
+     * Updates globalMaxId to be greater than the id of all passed flashcards.
+     *
+     * @param flashcardList List of flashcard to calculate the max id over.
+     */
+    public static void calculateAndUpdateGlobalMaxId(
+            FlashcardList flashcardList) {
         int currentMax = 1;
 
         for (Flashcard flashcard : flashcardList.getFlashcards()){
@@ -34,35 +48,46 @@ public static void calculateAndUpdateGlobalMaxId(FlashcardList flashcardList) {
         globalMaxId = currentMax + 1;
     }
 
-    public String getFrontText() {
-        return frontText;
-    }
-
     public int getId() {
         return id;
     }
 
-    public String getBackText() {
-        return backText;
-    }
-
     //@@author junhyeong0411
     public void setId (int id) {
         this.id = id;
     }
 
+    public String getFrontText() {
+        return frontText;
+    }
+
     public void setDifficulty(int difficulty) {
         this.difficulty = difficulty;
     }
 
+    public String getBackText() {
+        return backText;
+    }
+
 
     //@@author wendelinwemhoener
+    /**
+     * Returns a string representation of this flashcard.
+     *
+     * @return Front and back text as well as id and difficulty.
+     */
     public String toString() {
         return "front text: " + frontText + System.lineSeparator()
                 + "back text: " + backText + System.lineSeparator()
-                + "id: " + id + System.lineSeparator();
+                + "id: " + id
+                + "difficulty: " + difficulty + System.lineSeparator();
     }
 
+    /**
+     * Adjusts (increases) the difficulty of this flashcard.
+     *
+     * @param difficultyChange The amount to increase the difficulty by.
+     */
     public void applyDifficultyChange(int difficultyChange) {
         difficulty += difficultyChange;
     }

src/main/java/seedu/duke/flashcard/FlashcardCommandParser.java

@@ -10,7 +10,17 @@
 import seedu.duke.flashcard.command.DeleteFlashcardCommand;
 import seedu.duke.flashcard.command.UnknownCommand;
 
+/**
+ * Parses input entered by the user into a FlashcardCommand for further
+ * processing.
+ */
 public class FlashcardCommandParser {
+    /**
+     * Returns the FlashcardCommand corresponding to the passed input.
+     *
+     * @param input The text inputted by the user.
+     * @return The FlashcardCommand corresponding to input
+     */
     public FlashcardCommand parseInput(String input) {
         assert input != null : "input is null";
 

src/main/java/seedu/duke/flashcard/FlashcardComponent.java

@@ -8,17 +8,20 @@
 import java.io.FileNotFoundException;
 import java.util.ArrayList;
 
+/**
+ * Encapsulates all classes needed for the flashcard functionality and
+ * allows access to them via one unified API.
+ */
 public class FlashcardComponent {
     private FlashcardCommandParser parser;
     private FlashcardList flashcardList;
     private FlashcardUi ui;
     private FlashcardStorage storage;
 
-
+    //@@author junhyeong0411
     public FlashcardComponent() {
         parser = new FlashcardCommandParser();
 
-        //@@author junhyeong0411
         FlashcardDirectory flashcarddirectory = new FlashcardDirectory();
         flashcarddirectory.listFlashcardFiles();
 
@@ -30,12 +33,10 @@ public FlashcardComponent() {
             flashcardList = new FlashcardList(new ArrayList<>());
         }
 
-        //@@author wendelinwemhoener
         Flashcard.calculateAndUpdateGlobalMaxId(flashcardList);
         ui = new FlashcardUi(flashcardList);
     }
 
-    //@@author junhyeong0411
     public FlashcardStorage getStorage(){
         return this.storage;
     }
@@ -54,6 +55,12 @@ public FlashcardUi getUi(){
     }
 
     //@@author wendelinwemhoener
+    /**
+     * Returns if FlashcardComponent is responsible for handling this input.
+     *
+     * @param input The text inputted by the user.
+     * @return Whether FlashcardComponent is responsible for handling the input.
+     */
     public boolean isResponsible(String input) {
         FlashcardCommand command = parser.parseInput(input);
 
@@ -64,6 +71,11 @@ public boolean isResponsible(String input) {
         }
     }
 
+    /**
+     * Processes user input by parsing it and executing the resulting command.
+     *
+     * @param input The text inputted by the user.
+     */
     public void processInput(String input) {
         FlashcardCommand command = parser.parseInput(input);
         assert !(command instanceof UnknownCommand) : "Command cannot be " +
@@ -74,7 +86,5 @@ public void processInput(String input) {
         //@@author junhyeong0411
         // save after every commands
         storage.saveFlashcards(flashcardList.getFlashcards());
-
-        //@@author wendelinwemhoener
     }
 }

src/main/java/seedu/duke/flashcard/FlashcardList.java

@@ -4,9 +4,18 @@
 
 import java.util.ArrayList;
 
+/**
+ * Container class for a list of flashcards.
+ * Exposes a simple, unified API for dealing with a list of flashcards.
+ */
 public class FlashcardList {
     private ArrayList<Flashcard> flashcards;
 
+    /**
+     * Instantiates and returns a FlashcardList holding the passed flashcards.
+     *
+     * @param flashcards The flashcards to be contained by the FlashcardList.
+     */
     public FlashcardList(ArrayList<Flashcard> flashcards) {
         this.flashcards = flashcards;
     }
@@ -15,25 +24,47 @@ public ArrayList<Flashcard> getFlashcards() {
         return flashcards;
     }
 
-    // @@author junhyeong0411
+    /**
+     * Returns the amount of flashcards held by the FlashcardList.
+     *
+     * @return The size of the FlashcardList.
+     */
     public int getSize(){
         return flashcards.size();
     }
 
-
-    //@@author wendelinwemhoener
+    /**
+     * Adds a flashcard to the FlashcardList.
+     *
+     * @param flashcard The flashcard that shall be added.
+     */
     public void add(Flashcard flashcard) {
         flashcards.add(flashcard);
     }
 
+    /**
+     * Deletes all flashcards in the FlashcardList, effectively emptying it.
+     */
     public void deleteAllFlashcards() {
         flashcards.clear();
     }
 
+    /**
+     * Returns whether the FlashcardList contains any flashcards or not.
+     *
+     * @return If the FlashcardList is empty.
+     */
     public boolean isEmpty() {
         return flashcards.isEmpty();
     }
 
+    /**
+     * Attempts to delete a flashcard by the passed id.
+     * If no flashcard with the passed id exists, returns false.
+     *
+     * @param flashcardId The id of the flashcard to delete.
+     * @return Whether the deletion was successful (true if successful).
+     */
     public boolean deleteFlashcardById(int flashcardId) {
         int indexToDeleteAt = -1;
 

src/main/java/seedu/duke/flashcard/FlashcardUi.java

@@ -6,15 +6,31 @@
 
 import java.util.Scanner;
 
+/**
+ * Responsible for interfacing with the user by managing the dispatching of
+ * commands to be executed and show to the user.
+ */
 public class FlashcardUi {
     private Scanner scanner;
     private FlashcardList flashcardList;
 
+    /**
+     * Instantiates and returns a new FlashcardUi.
+     *
+     * @param flashcardList The flashcards to be used for this Ui.
+     */
     public FlashcardUi(FlashcardList flashcardList) {
         scanner = new Scanner(System.in);
         this.flashcardList = flashcardList;
     }
 
+    /**
+     * Executes a command and provides it with the appropriate context.
+     * This context consists of a scanner for handling input and a
+     * FlashcardList to execute actions on.
+     *
+     * @param command The command that shall be executed.
+     */
     public void executeCommand(FlashcardCommand command) {
         command.execute(scanner, flashcardList);
     }

src/main/java/seedu/duke/flashcard/command/CreateFlashcardCommand.java

@@ -7,7 +7,19 @@
 
 import java.util.Scanner;
 
+/**
+ * This command allows creating a new flashcard by inputting its front and
+ * back text.
+ */
 public class CreateFlashcardCommand extends FlashcardCommand {
+    /**
+     * Creates a new flashcard.
+     * The user is asked to input the front and back text of the new
+     * flashcard, and then it is added to the flashcardList.
+     *
+     * @param scanner Scanner that allows handling user input.
+     * @param flashcardList Which flashcards to perform actions on.
+     */
     public void execute(Scanner scanner, FlashcardList flashcardList) {
         System.out.print("    Enter the front page text: ");
         String frontPageText = scanner.nextLine();

src/main/java/seedu/duke/flashcard/command/DeleteAllFlashcardsCommand.java

@@ -4,7 +4,16 @@
 
 import java.util.Scanner;
 
+/**
+ * This command allows deleting all current flashcards.
+ */
 public class DeleteAllFlashcardsCommand extends FlashcardCommand {
+    /**
+     * Deletes all flashcards from the flashcardList.
+     *
+     * @param scanner Scanner that allows handling user input.
+     * @param flashcardList Which flashcards to perform actions on.
+     */
     public void execute(Scanner scanner, FlashcardList flashcardList) {
         flashcardList.deleteAllFlashcards();
 

src/main/java/seedu/duke/flashcard/command/FlashcardCommand.java

@@ -6,6 +6,19 @@
 
 import java.util.Scanner;
 
+/**
+ * Abstract class that provides the interface for executing commands by using
+ * a Scanner for input and a FlashcardList to perform actions on as command
+ * execution context.
+ */
 public abstract class FlashcardCommand {
+    /**
+     * Executes a command, given the appropriate context.
+     * This context consists of a scanner for handling input and a
+     * FlashcardList to execute actions on.
+     *
+     * @param scanner Scanner that allows handling user input.
+     * @param flashcardList Which flashcards to perform actions on.
+     */
     public abstract void execute(Scanner scanner, FlashcardList flashcardList);
 }

src/main/java/seedu/duke/flashcard/command/ListFlashcardsCommand.java

@@ -7,7 +7,18 @@
 
 import java.util.Scanner;
 
+/**
+ * This command allows listing all current flashcards.
+ */
 public class ListFlashcardsCommand extends FlashcardCommand {
+    /**
+     * Prints out a list of all current flashcards.
+     * Handles the scenario that there are no flashcards by printing an
+     * appropriate "You dont't have any flashcards yet!" message.
+     *
+     * @param scanner Scanner that allows handling user input.
+     * @param flashcardList Which flashcards to perform actions on.
+     */
     public void execute(Scanner scanner, FlashcardList flashcardList) {
         if (flashcardList.isEmpty()) {
             System.out.println("    You dont't have any flashcards yet! ");