From cc3db26d774fb0d4cbd3b7b75578f3a91cdf5b08 Mon Sep 17 00:00:00 2001
From: fdai7600 <firas.fradi@informatik.hs-fulda.de>
Date: Tue, 6 Feb 2024 19:09:26 +0100
Subject: [PATCH] Added Documentation (comments) to class Professor

---
 src/main/java/org/example/Professor.java | 61 ++++++++++++++++++++++--
 1 file changed, 58 insertions(+), 3 deletions(-)

diff --git a/src/main/java/org/example/Professor.java b/src/main/java/org/example/Professor.java
index a1dad96..10b1079 100644
--- a/src/main/java/org/example/Professor.java
+++ b/src/main/java/org/example/Professor.java
@@ -1,43 +1,98 @@
 package org.example;
-
+/**
+ * Represents a professor in the system.
+ * This class holds the details of a professor including their ID, name, and role.
+ */
 public class Professor {
+
+    // Unique identifier for the professor
     private String professorID;
+
+    // Name of the professor
     private String Name;
+
+    // Role of the professor in the system
     public String role;
 
+    /**
+     * Default constructor.
+     */
     public Professor() {
     }
 
+    /**
+     * Constructs a new Professor with the specified ID, name, and role.
+     *
+     * @param professorID the unique identifier for the professor
+     * @param name the name of the professor
+     * @param role the role of the professor in the system
+     */
     public Professor(String professorID, String name, String role) {
         this.professorID = professorID;
-        Name = name;
+        this.Name = name;
         this.role = role;
     }
 
+    /**
+     * Retrieves the professor's ID.
+     *
+     * @return the unique identifier for the professor
+     */
     public String getProfessorID() {
         return professorID;
     }
 
+    /**
+     * Sets the professor's ID to the specified value.
+     *
+     * @param professorID the unique identifier for the professor
+     */
     public void setProfessorID(String professorID) {
         this.professorID = professorID;
     }
 
+    /**
+     * Retrieves the professor's name.
+     *
+     * @return the name of the professor
+     */
     public String getName() {
         return Name;
     }
 
+    /**
+     * Sets the professor's name to the specified value.
+     *
+     * @param name the name of the professor
+     */
     public void setName(String name) {
-        Name = name;
+        this.Name = name;
     }
 
+    /**
+     * Retrieves the role of the professor in the system.
+     *
+     * @return the role of the professor
+     */
     public String getRole() {
         return role;
     }
 
+    /**
+     * Sets the role of the professor in the system to the specified value.
+     *
+     * @param role the role of the professor
+     */
     public void setRole(String role) {
         this.role = role;
     }
 
+    /**
+     * Returns a string representation of the Professor object.
+     * The string includes the professor's ID, name, and role.
+     *
+     * @return a string representation of the Professor object
+     */
     @Override
     public String toString() {
         return "Professor{" +