From 0e3339ab64a8202025fd5c753a7fb7440aaee938 Mon Sep 17 00:00:00 2001
From: Tobias Herbert <tobias-manfred.herbert@informatik.hs-fulda.de>
Date: Tue, 6 Feb 2024 18:04:38 +0100
Subject: [PATCH] Documentation: Admin Class

---
 src/main/java/org/example/Admin.java | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/src/main/java/org/example/Admin.java b/src/main/java/org/example/Admin.java
index 1da2bfa..abe8cbc 100644
--- a/src/main/java/org/example/Admin.java
+++ b/src/main/java/org/example/Admin.java
@@ -1,5 +1,8 @@
 package org.example;
 
+/**
+ *  Represents an administrative user in the system.
+ */
 public class Admin {
     public String name;
     public String id;
@@ -8,6 +11,12 @@ public class Admin {
     public Admin() {
     }
 
+    /**
+     *
+     * @param name the name of the admin
+     * @param id    the id of the admin
+     * @param role  the role of the admin in the system (should typically be "Admin")
+     */
     public Admin(String name, String id, String role) {
         this.name = name;
         this.id = id;
@@ -34,6 +43,10 @@ public class Admin {
         this.role = role;
     }
 
+    /**
+     * Prints the basic information of the admin in the console.
+     * This methods displays the admin´s ID, name and role, providing a quick overview of the admin´s identity
+     */
     public void printAdminInfo()
     {
         System.out.println("Name: " + getName());