Documentation.

Author: DxsSucuk

src/main/java/de/presti/ree6/sql/entities/Punishments.java

@@ -1,14 +1,55 @@
 package de.presti.ree6.sql.entities;
 
+import jakarta.persistence.Entity;
 import jakarta.persistence.Id;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
 
+/**
+ * Entity class for the Warning punishments.
+ */
+@Getter
+@Setter
+@Entity
+@NoArgsConstructor
+@AllArgsConstructor
 public class Punishments {
+
+    /**
+     * The id of the punishment.
+     */
     @Id
     long id;
+
+    /**
+     * The guild that it is bound to.
+     */
     long guildId;
+
+    /**
+     * The required warnings.
+     */
     int warnings;
+
+    /**
+     * The action (1 -> timeout, 2 -> roleAdd, 3 -> roleRemove, 4 -> kick, 5 -> ban)
+     */
     int action;
+
+    /**
+     * The Role id related to the role actions.
+     */
     long roleId;
+
+    /**
+     * The Timeout time in milliseconds for the timeout action.
+     */
     long timeoutTime;
+
+    /**
+     * The reason for the kick and ban action.
+     */
     String reason;
 }

src/main/java/de/presti/ree6/sql/entities/Warning.java

@@ -7,16 +7,34 @@
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 
+/**
+ * A Entity representing the warnings a user has received on a specific guild.
+ */
 @Getter
 @Setter
 @Entity
 @NoArgsConstructor
 @AllArgsConstructor
 public class Warning {
 
+    /**
+     * The id of the warning.
+     */
     @Id
     long id;
+
+    /**
+     * The user id its bound to.
+     */
     long userId;
+
+    /**
+     * The guild id its bound to.
+     */
     long guildId;
+
+    /**
+     * The warnings that the user has.
+     */
     int warnings;
 }