Updates docstring

src/app/authentication/components/login/login.component.ts

@@ -15,23 +15,35 @@ export class LoginComponent implements OnInit {
 
   constructor(private apiService: ApiService, private router: Router) {}
 
+  /**
+   * If the user is already authenticated, redirect them to the home page.
+   */
   ngOnInit(): void {
     if (this.apiService.isAuthenticated()) {
       this.handleSuccessfulLogin();
     }
   }
 
+  /**
+   * Passes user provided credentials to th backend API and handle the authentication result.
+   */
   onSubmit(): void {
     this.apiService.login(this.username, this.password).subscribe({
       next: () => {this.handleSuccessfulLogin()},
       error: () => {this.handleUnsuccessfulLogin()}
     })
   }
 
+  /**
+   * Redirects the user to the home page upon successful login.
+   */
   handleSuccessfulLogin(): void {
     this.router.navigateByUrl('');
   }
 
+  /**
+   * Updates page content to alert the user their login was unsuccessful.
+   */
   handleUnsuccessfulLogin(): void {
     alert('Could not authenticate.');
   }

src/app/authentication/components/logout/logout.component.ts

@@ -10,6 +10,9 @@ export class LogoutComponent implements OnInit{
 
   constructor(private apiService: ApiService) {}
 
+  /**
+   * Automatically log the user out on page loa
+   */
   ngOnInit(): void {
     this.apiService.logout()
   }