java doc for IUserDataAccess

Author: jempio

src/main/java/data_access/IFlashcardDataAccess.java

@@ -4,7 +4,7 @@
 
 // use case layer
 
-public interface IFlashcardDataAccess {
+public interface    IFlashcardDataAccess {
 
     FlashcardDsRequestModel getFlashcard(Integer flashcardID);
 

src/main/java/data_access/IUserDataAccess.java

@@ -4,7 +4,11 @@
 
 import java.util.Collection;
 
-// use case layer
+/**
+ * User Data Access Interface.
+ * Application Business Rules
+ * @author Justin Li
+ */
 
 public interface IUserDataAccess {
 
@@ -13,14 +17,27 @@ public interface IUserDataAccess {
      * @return the User object who has username
      */
     CommonUserDsRequestModel getUser(String username);
-
+    /**
+     * @param username the user's username
+     * @return True if the user's username is in the database
+     */
     boolean existsByName(String username);
-
+    /**
+     * @return all the User objects in the database
+     */
     Collection<CommonUserDsRequestModel> getAllUsers();
-
-    void saveFlashcardSetID(String username, int FlashcardSetID);
-
-    void deleteFlashcardSetID(String username, int FlashcardSetID);
-
+    /**
+     * @param username the user's username
+     * @param flashcardSetID the id of the flashcard set that the user would like to create.
+     */
+    void saveFlashcardSetID(String username, int flashcardSetID);
+    /**
+     * @param username the user's username
+     * @param flashcardSetID the id of the flashcard set that the user would like to delete.
+     */
+    void deleteFlashcardSetID(String username, int flashcardSetID);
+    /**
+     * @param user the User object.
+     */
     void saveUser(CommonUserDsRequestModel user);
 }