Updated docstrings

1 files changed, 17 insertions, 4 deletions

diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/controller/UserController.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/controller/UserController.java
index 0bb3fcf..795ca13 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/controller/UserController.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/controller/UserController.java
@@ -6,11 +6,19 @@ import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import com.ufund.api.ufundapi.DuplicateKeyException;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.*;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
 
+import com.ufund.api.ufundapi.DuplicateKeyException;
 import com.ufund.api.ufundapi.model.User;
 import com.ufund.api.ufundapi.service.AuthService;
 import com.ufund.api.ufundapi.service.UserService;
@@ -29,7 +37,7 @@ public class UserController {
 
     /**
      * Creates a User with the provided object
-     *
+     * @param params A map consisting of the parameters for a user
      * @return OK response and the user if it was successful, INTERNAL_SERVER_ERROR
      *         otherwise
      */
@@ -55,6 +63,8 @@ public class UserController {
     /**
      * Responds to the GET request for a {@linkplain User user} for the given id
      * 
+     * @param username The name of the user
+     * @param key      The authentication key of the user
      * @return ResponseEntity with {@link User user} object and HTTP status of OK if
      *         found<br>
      *         ResponseEntity with HTTP status of NOT_FOUND if not found<br>
@@ -84,7 +94,9 @@ public class UserController {
     /**
      * Updates a User with the provided one
      * 
-     * @param user The user to update
+     * @param user     The user to update
+     * @param username The name of the user
+     * @param key      The authentication key of the user
      * @return OK response and the user if it was successful, or
      *         INTERNAL_SERVER_ERROR if there was an issue
      */
@@ -111,6 +123,7 @@ public class UserController {
      * Deletes a user with the desired name
      * 
      * @param username The name of the user
+     * @param key      The authentication key of the user
      * @return OK if the user was deleted, NOT_FOUND if the user was not found, or
      *         INTERNAL_SERVER_ERROR if an error occurred
      */