JeremyStarTM/Engine
1
0
Fork 0
forked from StarOpenSource/Engine
Code Pull requests Activity Actions

Fix Javadoc warnings

Browse source
This commit is contained in:
JeremyStar™ 2024-08-21 21:19:22 +02:00
parent b4f5829375
commit 6a2a18095b
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
2 changed files with 62 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
base/src/main/java/de/staropensource/sosengine/base/EngineInternals.java
View file

@ -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<>();

58
base/src/main/java/de/staropensource/sosengine/base/logging/PrintStreamService.java
View file

@ -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.
*