From bba645f69b8267f0f610f142718519aa85e4d243 Mon Sep 17 00:00:00 2001
From: JeremyStarTM <jeremystartm@staropensource.de>
Date: Fri, 28 Jun 2024 01:11:55 +0200
Subject: [PATCH] Add @since tag to classes in unittests package

---
 .../sosengine/unittests/UnitConfig.java         |  9 +++++++--
 .../sosengine/unittests/UnitLogger.java         | 17 +++++++++++++++--
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/base/src/main/java/de/staropensource/sosengine/unittests/UnitConfig.java b/base/src/main/java/de/staropensource/sosengine/unittests/UnitConfig.java
index 118ccc03..f41f1746 100644
--- a/base/src/main/java/de/staropensource/sosengine/unittests/UnitConfig.java
+++ b/base/src/main/java/de/staropensource/sosengine/unittests/UnitConfig.java
@@ -23,18 +23,23 @@ import de.staropensource.sosengine.base.classes.logging.LogLevel;
 
 /**
  * Static configuration for the sos!engine unit testing helpers.
+ *
+ * @since 1-alpha0
  */
 public class UnitConfig {
     /**
      * Constructor.
+     *
+     * @since 1-alpha0
      */
     public UnitConfig() {}
 
     /**
      * Configures the {@link LogLevel} for the {@link UnitLogger}.<br/>
-     * Note: The log level {@code SILENT_WARNING} is used for printing test calls.
+     * Note: The log level {@code SILENT_WARNING} has been repurposed for printing test calls.
      *
-     * @see de.staropensource.sosengine.base.logging.Logger
+     * @see UnitLogger
+     * @since 1-alpha0
      */
     public static LogLevel loggerLevel = LogLevel.SILENT_WARNING;
 }
diff --git a/base/src/main/java/de/staropensource/sosengine/unittests/UnitLogger.java b/base/src/main/java/de/staropensource/sosengine/unittests/UnitLogger.java
index 5abd55dc..7adc6ba3 100644
--- a/base/src/main/java/de/staropensource/sosengine/unittests/UnitLogger.java
+++ b/base/src/main/java/de/staropensource/sosengine/unittests/UnitLogger.java
@@ -27,11 +27,15 @@ import java.util.List;
 
 /**
  * Provides a extremely dead simple logging system for unit tests.
+ *
+ * @since 1-alpha0
  */
 @SuppressWarnings("unused")
 public class UnitLogger {
     /**
      * The parent class.
+     *
+     * @since 1-alpha0
      */
     private final Class<?> clazz;
 
@@ -39,6 +43,7 @@ public class UnitLogger {
      * Constructor.
      *
      * @param clazz parent class
+     * @since 1-alpha0
      */
     public UnitLogger(Class<?> clazz) {
         this.clazz = clazz;
@@ -47,8 +52,10 @@ public class UnitLogger {
     /**
      * Prints a log message.
      *
-     * @param level   log level
-     * @param message log message (and arguments if called with level {@code SILENT_WARNING})
+     * @param level           log level
+     * @param message         log message
+     * @param additionalStuff additional arguments
+     * @since 1-alpha0
      */
     private void log(@NotNull LogLevel level, @NotNull String message, List<@Nullable Object> additionalStuff) {
         String messageSingle = message;
@@ -93,6 +100,7 @@ public class UnitLogger {
      * Prints a diagnostic message.
      *
      * @param message diagnostic log message
+     * @since 1-alpha0
      */
     public void diag(@NotNull String message) {
         log(LogLevel.DIAGNOSTIC, message, null);
@@ -102,6 +110,7 @@ public class UnitLogger {
      * Prints a verbose message.
      *
      * @param message verbose log message
+     * @since 1-alpha0
      */
     public void verb(@NotNull String message) {
         log(LogLevel.VERBOSE, message, null);
@@ -112,6 +121,7 @@ public class UnitLogger {
      *
      * @param methodName name of the test method called
      * @param methodArgs arguments of the test method called
+     * @since 1-alpha0
      */
     public void testCall(@NotNull String methodName, @Nullable Object ... methodArgs) {
         log(LogLevel.SILENT_WARNING, methodName, List.of(methodArgs));
@@ -121,6 +131,7 @@ public class UnitLogger {
      * Prints a informational message.
      *
      * @param message informational log message
+     * @since 1-alpha0
      */
     public void info(@NotNull String message) {
         log(LogLevel.INFORMATIONAL, message, null);
@@ -130,6 +141,7 @@ public class UnitLogger {
      * Prints a warning message.
      *
      * @param message warning log message
+     * @since 1-alpha0
      */
     public void warn(@NotNull String message) {
         log(LogLevel.WARNING, message, null);
@@ -139,6 +151,7 @@ public class UnitLogger {
      * Prints a error message.
      *
      * @param message error log message
+     * @since 1-alpha0
      */
     public void error(@NotNull String message) {
         log(LogLevel.ERROR, message, null);