From 6a2a18095bc4701b0b62e0b985f16305f4e5130d Mon Sep 17 00:00:00 2001
From: JeremyStarTM <jeremystartm@staropensource.de>
Date: Wed, 21 Aug 2024 21:19:22 +0200
Subject: [PATCH] Fix Javadoc warnings

---
 .../sosengine/base/EngineInternals.java       |  5 ++
 .../base/logging/PrintStreamService.java      | 58 ++++++++++++++++++-
 2 files changed, 62 insertions(+), 1 deletion(-)

diff --git a/base/src/main/java/de/staropensource/sosengine/base/EngineInternals.java b/base/src/main/java/de/staropensource/sosengine/base/EngineInternals.java
index cbd807e..a77f4b8 100644
--- a/base/src/main/java/de/staropensource/sosengine/base/EngineInternals.java
+++ b/base/src/main/java/de/staropensource/sosengine/base/EngineInternals.java
@@ -63,6 +63,11 @@ public final class EngineInternals {
      * Contains all disabled internal access areas.
      *
      * @since v1-alpha4
+     * -- GETTER --
+     * Returns all disabled internal access areas.
+     *
+     * @return restricted areas
+     * @since v1-alpha4
      */
     @Getter
     private final @NotNull List<@NotNull InternalAccessArea> restrictedAreas = new ArrayList<>();
diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/PrintStreamService.java b/base/src/main/java/de/staropensource/sosengine/base/logging/PrintStreamService.java
index 028ae2d..6b0fb76 100644
--- a/base/src/main/java/de/staropensource/sosengine/base/logging/PrintStreamService.java
+++ b/base/src/main/java/de/staropensource/sosengine/base/logging/PrintStreamService.java
@@ -34,8 +34,8 @@ import java.nio.charset.StandardCharsets;
  *
  * @since v1-alpha4
  */
+@SuppressWarnings({ "unused" })
 public final class PrintStreamService {
-
     /**
      * Contains the {@link LoggerInstance} for this instance.
      *
@@ -50,6 +50,13 @@ public final class PrintStreamService {
      * {@link Logger#info(Class, String, String, String)}
      *
      * @since v1-alpha4
+     * -- GETTER --
+     * Returns the diagnostic stream.
+     * Anything sent will be redirected to
+     * {@link Logger#info(Class, String, String, String)}
+     *
+     * @return diagnostic stream
+     * @since v1-alpha4
      */
     @Getter
     private static PrintStream diag = null;
@@ -60,6 +67,13 @@ public final class PrintStreamService {
      * {@link Logger#error(Class, String, String, String)}
      *
      * @since v1-alpha4
+     * -- GETTER --
+     * Returns the verbose stream.
+     * Anything sent will be redirected to
+     * {@link Logger#error(Class, String, String, String)}
+     *
+     * @return verbose stream
+     * @since v1-alpha4
      */
     @Getter
     private static PrintStream verb = null;
@@ -70,6 +84,13 @@ public final class PrintStreamService {
      * {@link Logger#error(Class, String, String, String)}
      *
      * @since v1-alpha4
+     * -- GETTER --
+     * Returns the silent warning stream.
+     * Anything sent will be redirected to
+     * {@link Logger#error(Class, String, String, String)}
+     *
+     * @return silent warning stream
+     * @since v1-alpha4
      */
     @Getter
     private static PrintStream sarn = null;
@@ -80,6 +101,13 @@ public final class PrintStreamService {
      * {@link Logger#info(Class, String, String, String)}
      *
      * @since v1-alpha4
+     * -- GETTER --
+     * Returns the informational stream.
+     * Anything sent will be redirected to
+     * {@link Logger#info(Class, String, String, String)}
+     *
+     * @return informational stream
+     * @since v1-alpha4
      */
     @Getter
     private static PrintStream info = null;
@@ -90,6 +118,13 @@ public final class PrintStreamService {
      * {@link Logger#error(Class, String, String, String)}
      *
      * @since v1-alpha4
+     * -- GETTER --
+     * Returns the warning stream.
+     * Anything sent will be redirected to
+     * {@link Logger#error(Class, String, String, String)}
+     *
+     * @return warning stream
+     * @since v1-alpha4
      */
     @Getter
     private static PrintStream warn = null;
@@ -100,6 +135,13 @@ public final class PrintStreamService {
      * {@link Logger#info(Class, String, String, String)}
      *
      * @since v1-alpha4
+     * -- GETTER --
+     * Returns the error stream.
+     * Anything sent will be redirected to
+     * {@link Logger#info(Class, String, String, String)}
+     *
+     * @return error stream
+     * @since v1-alpha4
      */
     @Getter
     private static PrintStream error = null;
@@ -110,10 +152,24 @@ public final class PrintStreamService {
      * {@link Logger#error(Class, String, String, String)}
      *
      * @since v1-alpha4
+     * -- GETTER --
+     * Returns the crash stream.
+     * Anything sent will be redirected to
+     * {@link Logger#error(Class, String, String, String)}
+     *
+     * @return crash stream
+     * @since v1-alpha4
      */
     @Getter
     private static PrintStream crash = null;
 
+    /**
+     * Constructs this class.
+     *
+     * @since v1-alpha4
+     */
+    public PrintStreamService() {}
+
     /**
      * Initializes all {@link PrintStream}s offered by this class.
      *