From 58e57978fd3aab4b66aaff08befcced7f826645f Mon Sep 17 00:00:00 2001
From: s-prechtl <sprechtl@htl-steyr.ac.at>
Date: Tue, 27 Sep 2022 07:37:13 +0200
Subject: [PATCH] Function comments

---
 frontend/svelte/src/models/customToasts.ts                | 4 ++++
 frontend/svelte/src/models/user.ts                        | 3 +++
 frontend/svelte/src/routes/login/+page.svelte             | 3 +++
 frontend/svelte/src/routes/login/models/authentication.ts | 3 +++
 4 files changed, 13 insertions(+)

diff --git a/frontend/svelte/src/models/customToasts.ts b/frontend/svelte/src/models/customToasts.ts
index b50a821..41e7924 100644
--- a/frontend/svelte/src/models/customToasts.ts
+++ b/frontend/svelte/src/models/customToasts.ts
@@ -1,6 +1,10 @@
 import {toast} from "@zerodevx/svelte-toast";
 import {capitalizeFirstLetter} from "./PomeloUtils";
 
+/**
+ * Creates an error message toast with red background.
+ * @param m
+ */
 export const createErrorToast = (m: string) => {
     toast.push("Error: " + capitalizeFirstLetter(m), {
         theme: {
diff --git a/frontend/svelte/src/models/user.ts b/frontend/svelte/src/models/user.ts
index fe5e669..9d6b509 100644
--- a/frontend/svelte/src/models/user.ts
+++ b/frontend/svelte/src/models/user.ts
@@ -1,3 +1,6 @@
+/**
+ * User.
+ */
 export class User {
     id: number;
     email: string;
diff --git a/frontend/svelte/src/routes/login/+page.svelte b/frontend/svelte/src/routes/login/+page.svelte
index bd3cc51..27d2585 100644
--- a/frontend/svelte/src/routes/login/+page.svelte
+++ b/frontend/svelte/src/routes/login/+page.svelte
@@ -10,6 +10,9 @@
     let rememberMe: boolean = true;
 
 
+    /**
+     * Handles the button click.
+     */
     async function handleSubmit() {
         const endpoint = "http://localhost:1337/api/auth/local";
         const payload = {
diff --git a/frontend/svelte/src/routes/login/models/authentication.ts b/frontend/svelte/src/routes/login/models/authentication.ts
index 512d866..dccb434 100644
--- a/frontend/svelte/src/routes/login/models/authentication.ts
+++ b/frontend/svelte/src/routes/login/models/authentication.ts
@@ -1,5 +1,8 @@
 import type {User} from "../../../models/user";
 
+/**
+ * User Login Auth.
+ */
 export interface Authentication {
     jwt: string;
     user: User;