From fa8a30e9406f5452059e0ffcc4d26a3046e18e93 Mon Sep 17 00:00:00 2001
From: Chneemann <andre-kempf@mailbox.org>
Date: Fri, 2 May 2025 20:02:00 +0200
Subject: [PATCH] docs: add JSDoc comments to AuthGuard functions and move to
 dedicated folder

---
 frontend/src/app/app.routes.ts              |  2 +-
 frontend/src/app/auth.guard.spec.ts         | 17 -----------------
 frontend/src/app/{ => guards}/auth.guard.ts |  8 +++++++-
 3 files changed, 8 insertions(+), 19 deletions(-)
 delete mode 100644 frontend/src/app/auth.guard.spec.ts
 rename frontend/src/app/{ => guards}/auth.guard.ts (66%)

diff --git a/frontend/src/app/app.routes.ts b/frontend/src/app/app.routes.ts
index 3adeba8..aff9b79 100644
--- a/frontend/src/app/app.routes.ts
+++ b/frontend/src/app/app.routes.ts
@@ -3,7 +3,7 @@ import { ImprintComponent } from './shared/components/legal-information/imprint/
 import { PrivacyPolicyComponent } from './shared/components/legal-information/privacy-policy/privacy-policy.component';
 import { HomeComponent } from './components/home/home.component';
 import { AuthComponent } from './components/auth/auth.component';
-import { AuthGuard } from './auth.guard';
+import { AuthGuard } from './guards/auth.guard';
 
 export const routes: Routes = [
   { path: '', component: AuthComponent },
diff --git a/frontend/src/app/auth.guard.spec.ts b/frontend/src/app/auth.guard.spec.ts
deleted file mode 100644
index 4ae275e..0000000
--- a/frontend/src/app/auth.guard.spec.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-import { TestBed } from '@angular/core/testing';
-import { CanActivateFn } from '@angular/router';
-
-import { authGuard } from './auth.guard';
-
-describe('authGuard', () => {
-  const executeGuard: CanActivateFn = (...guardParameters) => 
-      TestBed.runInInjectionContext(() => authGuard(...guardParameters));
-
-  beforeEach(() => {
-    TestBed.configureTestingModule({});
-  });
-
-  it('should be created', () => {
-    expect(executeGuard).toBeTruthy();
-  });
-});
diff --git a/frontend/src/app/auth.guard.ts b/frontend/src/app/guards/auth.guard.ts
similarity index 66%
rename from frontend/src/app/auth.guard.ts
rename to frontend/src/app/guards/auth.guard.ts
index 5acb96d..ea5c71e 100644
--- a/frontend/src/app/auth.guard.ts
+++ b/frontend/src/app/guards/auth.guard.ts
@@ -2,7 +2,7 @@ import { Injectable } from '@angular/core';
 import { Router } from '@angular/router';
 import { Observable, of } from 'rxjs';
 import { map, catchError } from 'rxjs/operators';
-import { AuthService } from './services/auth.service';
+import { AuthService } from '../services/auth.service';
 
 @Injectable({
   providedIn: 'root',
@@ -10,6 +10,12 @@ import { AuthService } from './services/auth.service';
 export class AuthGuard {
   constructor(private authService: AuthService, private router: Router) {}
 
+  /**
+   * Determines if the route can be activated by checking if the user is authenticated.
+   *
+   * @returns An Observable, Promise, or boolean indicating whether the route can be activated.
+   *          If the user is authenticated, returns true; otherwise, navigates to the root path and returns false.
+   */
   canActivate(): Observable<boolean> | Promise<boolean> | boolean {
     return this.authService.checkAuthUser().pipe(
       map((isAuthenticated) => {