login comp2

Author: Jaysalgado

src/App.tsx

@@ -50,6 +50,13 @@ const App = () => {
   useEffect(() => {
     checkLogin();
   }, [checkCookie, updateSession]);
+  /**
+   * checks if user was already logged in, and navigates them to home if cookie was already set
+   * @method
+   * @async
+   * @params none
+   * @returns {Promise<void>} navigates user to endpoint /home if they were logged in
+   */
 
   const navigateToHome = async () => {
     await checkLogin();

src/components/Login/Login.tsx

@@ -36,12 +36,12 @@ const Login = (props: loginProps): JSX.Element => {
     authenticateUser(username, password);
   };
 
-  /*
-  authenticates users username and password
-  @method
-  @async
-  @returns promise when sending a request to backend to login is successful, and updates users session and cookies
+  /** authenticates users username and password
+   * @method
+   * @async
+   * @returns {Promise<void>} returns promise when sending a request to backend to login is successful, and updates users session and cookies
   */
+ 
   const authenticateUser = async (
     username: string,
     password: string

src/components/Metrics/Metrics.tsx

@@ -11,7 +11,7 @@ const Metrics = (): JSX.Element => {
   const button = kubernetesOrNah === 1 ? 'Containers' : 'Kubernetes Cluster';
 
   useEffect(() => {
-    /*
+    /** 
     * Retrieves the API and UID key 
     * @method
     * @async