diff --git a/base/src/main/java/de/staropensource/sosengine/base/Engine.java b/base/src/main/java/de/staropensource/sosengine/base/Engine.java index f3e35f3..e677ea3 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/Engine.java +++ b/base/src/main/java/de/staropensource/sosengine/base/Engine.java @@ -63,14 +63,14 @@ import java.util.Set; @EngineSubsystem public final class Engine implements SubsystemMainClass { /** - * Instance. + * Contains the class instance. * * @since 1-alpha0 * * -- GETTER -- - * Returns the {@link Engine} instance. + * Returns the class instance. * - * @return {@link Engine} instance unless uninitialized + * @return class instance unless the engine is uninitialized * @since 1-alpha0 */ @Getter diff --git a/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java b/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java index 3249131..18654fa 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java +++ b/base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java @@ -22,9 +22,11 @@ package de.staropensource.sosengine.base; import de.staropensource.sosengine.base.classes.SubsystemConfiguration; import de.staropensource.sosengine.base.classes.logging.LogIssuer; import de.staropensource.sosengine.base.classes.logging.LogLevel; +import de.staropensource.sosengine.base.logging.CrashHandler; import de.staropensource.sosengine.base.logging.Logger; import de.staropensource.sosengine.base.types.CodePart; import de.staropensource.sosengine.base.utility.PropertyParser; +import de.staropensource.sosengine.base.utility.ShortcodeConverter; import lombok.Getter; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; @@ -32,7 +34,17 @@ import org.jetbrains.annotations.Nullable; import java.util.Properties; /** - * Provides the engine configuration for all classes in a centralized place. + * Provides the base engine configuration. + *

+ * This class does not only provide engine settings but is also + * responsible for loading them into memory from {@link Properties} objects. + *

+ * Now you might ask why we didn't go with the string-based approach. + * The answer is simple: It's a maintenance and documentation burden. + * Having various settings strings scattered across many classes will cause + * trouble at some point, which will cause some strings to be undocumented + * or have an inconsistent naming scheme. Containing settings as variables in + * one centralized place mitigates this. * * @since 1-alpha0 */ @@ -40,14 +52,14 @@ import java.util.Properties; @Getter public final class EngineConfiguration implements SubsystemConfiguration { /** - * Instance. + * Contains the class instance. * * @since 1-alpha0 * * -- GETTER -- - * Returns the {@link EngineConfiguration} instance. + * Returns the class instance. * - * @return {@link EngineConfiguration} instance unless {@link Engine} is uninitialized + * @return class instance unless {@link Engine} is uninitialized * @since 1-alpha0 */ @Getter @@ -99,10 +111,10 @@ public final class EngineConfiguration implements SubsystemConfiguration { private boolean debugEvents; /** - * If enabled, very verbose messages about the {@link de.staropensource.sosengine.base.utility.ShortcodeConverter}'s internals will be printed.
- * Don't enable unless you have knowledge about the {@link de.staropensource.sosengine.base.utility.ShortcodeConverter} and want to work on it. + * If enabled, very verbose messages about the {@link ShortcodeConverter}'s internals will be printed.
+ * Don't enable unless you want to work on it. * - * @see de.staropensource.sosengine.base.utility.ShortcodeConverter + * @see ShortcodeConverter * @since 1-alpha0 * * -- GETTER -- @@ -115,10 +127,11 @@ public final class EngineConfiguration implements SubsystemConfiguration { private boolean debugShortcodeConverter; /** - * If enabled, invalid shortcodes will be logged in {@link de.staropensource.sosengine.base.utility.ShortcodeConverter}. + * If enabled, invalid shortcodes will be logged by the {@link ShortcodeConverter}. * The message will be printed as a silent warning. * - * @see de.staropensource.sosengine.base.utility.ShortcodeConverter + * @see ShortcodeConverter + * @see EngineConfiguration#loggerLevel * @since 1-alpha0 * * -- GETTER -- @@ -131,7 +144,7 @@ public final class EngineConfiguration implements SubsystemConfiguration { private boolean errorShortcodeConverter; /** - * Determines which logger levels are allowed. + * Determines which logger levels are allowed by setting the minimum logger level. * * @see Logger * @since 1-alpha0 @@ -146,7 +159,7 @@ public final class EngineConfiguration implements SubsystemConfiguration { private LogLevel loggerLevel; /** - * Contains the logging template. + * Contains the logging template used for creating log messages. * * @see Logger * @see de.staropensource.sosengine.base.data.placeholder Global placeholder list @@ -163,10 +176,10 @@ public final class EngineConfiguration implements SubsystemConfiguration { private String loggerTemplate; /** - * If enabled, the JVM will immediately shutdown. This will prevent shutdown hooks from executing.
- * Note: This will also prevent Jansi from removing temporary native libraries at shutdown. + * If enabled, the JVM will immediately shutdown on an engine crash. This will prevent shutdown hooks from executing.
+ * Note: This will also prevent Jansi and potentially other libraries from removing temporary native libraries at shutdown. * - * @see de.staropensource.sosengine.base.logging.CrashHandler + * @see CrashHandler * @since 1-alpha0 * * -- GETTER -- @@ -179,7 +192,8 @@ public final class EngineConfiguration implements SubsystemConfiguration { private boolean loggerImmediateShutdown; /** - * If enabled, will force the {@link Logger} and {@link de.staropensource.sosengine.base.logging.CrashHandler} to use the standard output. + * If enabled, will force the {@link Logger} and {@link CrashHandler} to use the standard output + * instead of the standard error for logging {@code ERROR} and {@code CRASH}. * * @since 1-alpha0 * @@ -193,7 +207,7 @@ public final class EngineConfiguration implements SubsystemConfiguration { private boolean loggerForceStandardOutput; /** - * Determines how fast the logger will poll for messages. + * Determines how fast the logging thread will poll for queued messages. * Only applies if {@code optimizeLogging} is turned on. * * @see EngineConfiguration#optimizeLogging @@ -209,10 +223,11 @@ public final class EngineConfiguration implements SubsystemConfiguration { private int loggerPollingSpeed; /** - * If enabled, will makes the {@link Logger} work asynchronous. + * If enabled, will makes the {@link Logger} work asynchronous, in a separate platform thread. * Don't disable unless you want your application to run extremely slowly. * * @see EngineConfiguration#loggerPollingSpeed + * @see Thread * @since 1-alpha0 * * -- GETTER -- @@ -225,9 +240,10 @@ public final class EngineConfiguration implements SubsystemConfiguration { private boolean optimizeLogging; /** - * If enabled, will make all events asynchronous. - * Don't disable unless you want your application to run slowly. + * If enabled, will make all events asynchronous, in separate virtual threads. + * Don't disable unless you want your application to run slower. * + * @see VirtualThread * @since 1-alpha0 * * -- GETTER -- @@ -240,7 +256,7 @@ public final class EngineConfiguration implements SubsystemConfiguration { private boolean optimizeEvents; /** - * Constructor. + * Constructs this class. * * @see Engine * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemConfiguration.java b/base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemConfiguration.java index 4bc590b..2d798c9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemConfiguration.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemConfiguration.java @@ -31,7 +31,7 @@ import java.util.Properties; @SuppressWarnings({ "unused" }) public interface SubsystemConfiguration { /** - * Instance. + * Contains the class instance. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/EventHelper.java b/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/EventHelper.java index 71ee5fd..b3743f6 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/EventHelper.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/helpers/EventHelper.java @@ -22,8 +22,8 @@ package de.staropensource.sosengine.base.classes.helpers; import de.staropensource.sosengine.base.EngineConfiguration; import de.staropensource.sosengine.base.annotations.EventListener; import de.staropensource.sosengine.base.classes.events.Event; -import de.staropensource.sosengine.base.logging.Logger; import de.staropensource.sosengine.base.classes.logging.LogIssuer; +import de.staropensource.sosengine.base.logging.Logger; import de.staropensource.sosengine.base.utility.ListFormatter; import lombok.Getter; import org.jetbrains.annotations.NotNull; @@ -35,7 +35,10 @@ import org.reflections.util.ConfigurationBuilder; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; -import java.util.*; +import java.util.Comparator; +import java.util.HashMap; +import java.util.LinkedList; +import java.util.Set; /** * Represents an event. @@ -53,7 +56,7 @@ public class EventHelper { private static final HashMap<@NotNull Class, LinkedList<@NotNull Method>> cachedEventListeners = new HashMap<>(); /** - * Constructor. + * Constructs this class. */ public EventHelper() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/logging/LogIssuer.java b/base/src/main/java/de/staropensource/sosengine/base/classes/logging/LogIssuer.java index e088651..c29b4d9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/logging/LogIssuer.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/logging/LogIssuer.java @@ -73,7 +73,7 @@ public class LogIssuer { private final CodePart codePart; /** - * Constructor. + * Creates a new log issuer. * * @param clazz issuing class * @param additionalInformation additional information about the issuer @@ -88,7 +88,7 @@ public class LogIssuer { } /** - * Constructor. + * Creates a new log issuer. * * @param clazz issuing class * @param additionalInformation additional information about the issuer @@ -102,7 +102,7 @@ public class LogIssuer { } /** - * Constructor. + * Creates a new log issuer. * * @param clazz issuing class * @param codePart identifies to which part of the program the class belongs to @@ -115,7 +115,7 @@ public class LogIssuer { } /** - * Constructor. + * Creates a new log issuer. * * @param clazz issuing class * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/classes/logging/LogRule.java b/base/src/main/java/de/staropensource/sosengine/base/classes/logging/LogRule.java index 826743b..0ef57bb 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/classes/logging/LogRule.java +++ b/base/src/main/java/de/staropensource/sosengine/base/classes/logging/LogRule.java @@ -47,7 +47,7 @@ public class LogRule { private final LogRuleType type; /** - * Constructor. + * Creates a new log rule. * * @param type rule type */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/info/EngineInformation.java b/base/src/main/java/de/staropensource/sosengine/base/data/info/EngineInformation.java index bf7d850..01ce8fd 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/info/EngineInformation.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/info/EngineInformation.java @@ -45,14 +45,14 @@ import java.util.Properties; @Getter public final class EngineInformation { /** - * Instance. + * Contains the class instance. * * @since 1-alpha0 * * -- GETTER -- - * Returns the {@link EngineInformation} instance. + * Returns the class instance. * - * @return {@link EngineInformation} instance + * @return class instance unless {@link Engine} is uninitialized * @since 1-alpha0 */ @Getter @@ -349,7 +349,7 @@ public final class EngineInformation { private String pluginLombok; /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/info/JvmInformation.java b/base/src/main/java/de/staropensource/sosengine/base/data/info/JvmInformation.java index dd59ef3..d5e6997 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/info/JvmInformation.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/info/JvmInformation.java @@ -19,9 +19,9 @@ package de.staropensource.sosengine.base.data.info; +import de.staropensource.sosengine.base.classes.logging.LogIssuer; import de.staropensource.sosengine.base.logging.Logger; import de.staropensource.sosengine.base.types.CodePart; -import de.staropensource.sosengine.base.classes.logging.LogIssuer; import org.jetbrains.annotations.NotNull; import java.lang.management.ManagementFactory; @@ -33,7 +33,7 @@ import java.util.List; @SuppressWarnings({ "unused" }) public final class JvmInformation { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/DateDay.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/DateDay.java index 889c02a..22af6b7 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/DateDay.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/DateDay.java @@ -34,7 +34,7 @@ import java.util.Calendar; @SuppressWarnings({ "unused" }) public final class DateDay implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/DateMonth.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/DateMonth.java index dac767f..f9d6955 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/DateMonth.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/DateMonth.java @@ -34,7 +34,7 @@ import java.util.Calendar; @SuppressWarnings({ "unused" }) public final class DateMonth implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/DateYear.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/DateYear.java index e78ce10..44b9209 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/DateYear.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/DateYear.java @@ -34,7 +34,7 @@ import java.util.Calendar; @SuppressWarnings({ "unused" }) public final class DateYear implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyJansi.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyJansi.java index 4c79bba..8f8c7f5 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyJansi.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyJansi.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineDependencyJansi implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyJetbrainsAnnotations.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyJetbrainsAnnotations.java index 37f8612..3ee6aa7 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyJetbrainsAnnotations.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyJetbrainsAnnotations.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineDependencyJetbrainsAnnotations implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyLombok.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyLombok.java index ee7afde..6b74207 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyLombok.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyLombok.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineDependencyLombok implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyLwjgl.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyLwjgl.java index 4c05bcc..e126900 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyLwjgl.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyLwjgl.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineDependencyLwjgl implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyReflections.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyReflections.java index 80879b9..aa71bee 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyReflections.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencyReflections.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineDependencyReflections implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencySlf4j.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencySlf4j.java index 993bedb..ecffffa 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencySlf4j.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineDependencySlf4j.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineDependencySlf4j implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitBranch.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitBranch.java index 38df731..cdf68e9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitBranch.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitBranch.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitBranch implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitHeader.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitHeader.java index 11bb962..586ac23 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitHeader.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitHeader.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitHeader implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitIdLong.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitIdLong.java index 46d2119..87c36ca 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitIdLong.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitIdLong.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitIdLong implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitIdShort.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitIdShort.java index 9ff31ea..7a3da25 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitIdShort.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitIdShort.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitIdShort implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeDay.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeDay.java index b303618..5d54508 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeDay.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeDay.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitTimeDay implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeHour.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeHour.java index 92301d9..e18be34 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeHour.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeHour.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitTimeHour implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeMinute.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeMinute.java index 95df214..9f3419c 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeMinute.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeMinute.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitTimeMinute implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeMonth.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeMonth.java index 194535b..c8aaef9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeMonth.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeMonth.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitTimeMonth implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeSecond.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeSecond.java index a5968a8..0867259 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeSecond.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeSecond.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitTimeSecond implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeYear.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeYear.java index fc5bc47..37fa9c0 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeYear.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitTimeYear.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitTimeYear implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommits.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommits.java index 25dd2ea..bfb6159 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommits.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommits.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommits implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitterEmail.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitterEmail.java index f3ba820..c15d92b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitterEmail.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitterEmail.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitterEmail implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitterName.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitterName.java index 948d846..6e6f958 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitterName.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitCommitterName.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitCommitterName implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitDirty.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitDirty.java index 27bf9b9..36ca210 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitDirty.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineGitDirty.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineGitDirty implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EnginePluginLombok.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EnginePluginLombok.java index e24eb3e..dc2e559 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EnginePluginLombok.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EnginePluginLombok.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EnginePluginLombok implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EnginePluginShadow.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EnginePluginShadow.java index 5dc1a33..2746546 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EnginePluginShadow.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EnginePluginShadow.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EnginePluginShadow implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersion.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersion.java index 63aecce..715d37b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersion.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersion.java @@ -31,7 +31,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineVersion implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionFork.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionFork.java index a5b2a31..71634e7 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionFork.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionFork.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineVersionFork implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionType.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionType.java index 70dfb48..92c174b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionType.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionType.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineVersionType implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionTyperelease.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionTyperelease.java index ccff2be..9718572 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionTyperelease.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionTyperelease.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineVersionTyperelease implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionVersion.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionVersion.java index 8bd9826..3e666f0 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionVersion.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/EngineVersionVersion.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class EngineVersionVersion implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmArguments.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmArguments.java index fc7bc18..75866d2 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmArguments.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmArguments.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class JvmArguments implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmImplementationName.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmImplementationName.java index b6e7151..2fe2d32 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmImplementationName.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmImplementationName.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class JvmImplementationName implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmImplementationVendor.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmImplementationVendor.java index b2c0ab6..3297407 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmImplementationVendor.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmImplementationVendor.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class JvmImplementationVendor implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmImplementationVersion.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmImplementationVersion.java index f2e1cb9..1b54dde 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmImplementationVersion.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmImplementationVersion.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class JvmImplementationVersion implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmJava.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmJava.java index 89e1c6c..ec264fa 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmJava.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmJava.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class JvmJava implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmUptime.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmUptime.java index df17228..7e8b574 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmUptime.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/JvmUptime.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class JvmUptime implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeEpoch.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeEpoch.java index dad980a..e9e16f3 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeEpoch.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeEpoch.java @@ -33,7 +33,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class TimeEpoch implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeHour.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeHour.java index f421674..37da6fe 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeHour.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeHour.java @@ -34,7 +34,7 @@ import java.util.Calendar; @SuppressWarnings({ "unused" }) public final class TimeHour implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeMinute.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeMinute.java index 8d0047a..fc80a47 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeMinute.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeMinute.java @@ -34,7 +34,7 @@ import java.util.Calendar; @SuppressWarnings({ "unused" }) public final class TimeMinute implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeSecond.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeSecond.java index 143d1a0..6e9bc7c 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeSecond.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeSecond.java @@ -34,7 +34,7 @@ import java.util.Calendar; @SuppressWarnings({ "unused" }) public final class TimeSecond implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeZone.java b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeZone.java index 5f7f6b2..5dced7b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeZone.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/placeholder/TimeZone.java @@ -33,7 +33,7 @@ import java.util.Locale; @SuppressWarnings({ "unused" }) public final class TimeZone implements Placeholder { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java index 95d22d5..8939210 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/FourNumberVersioningSystem.java @@ -94,7 +94,7 @@ public final class FourNumberVersioningSystem implements VersioningSystem { } /** - * Constructor. + * Parses a four number-based version string. * * @param versionString version string to parse * @throws InvalidVersionStringException if the version string is invalid diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java index e90e03e..661f201 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/SemanticVersioningSystem.java @@ -113,7 +113,7 @@ public final class SemanticVersioningSystem implements VersioningSystem { } /** - * Constructor. + * Parses a semantic versioning string. * * @param versionString version string to parse * @throws InvalidVersionStringException if the version string is invalid diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java index 1b92c6d..03bddba 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/StarOpenSourceVersioningSystem.java @@ -113,7 +113,7 @@ public final class StarOpenSourceVersioningSystem implements VersioningSystem { } /** - * Constructor. + * Parses a StarOpenSource versioning string. * * @param versionString version string to parse * @throws InvalidVersionStringException if the version string is invalid diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java index fa1cfe7..3433b35 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/ThreeNumberVersioningSystem.java @@ -81,7 +81,7 @@ public final class ThreeNumberVersioningSystem implements VersioningSystem { } /** - * Constructor. + * Parses a three number-based version string. * * @param versionString version string to parse * @throws InvalidVersionStringException if the version string is invalid diff --git a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/TwoNumberVersioningSystem.java b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/TwoNumberVersioningSystem.java index da87d6b..7f6035e 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/data/versioning/TwoNumberVersioningSystem.java +++ b/base/src/main/java/de/staropensource/sosengine/base/data/versioning/TwoNumberVersioningSystem.java @@ -68,7 +68,7 @@ public final class TwoNumberVersioningSystem implements VersioningSystem { } /** - * Constructor. + * Parses a two number-based version string. * * @param versionString version string to parse * @throws InvalidVersionStringException if the version string is invalid diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/EngineCrashEvent.java b/base/src/main/java/de/staropensource/sosengine/base/events/EngineCrashEvent.java index f2d073c..3e8fcb4 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/events/EngineCrashEvent.java +++ b/base/src/main/java/de/staropensource/sosengine/base/events/EngineCrashEvent.java @@ -30,7 +30,7 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper; @SuppressWarnings({ "unused" }) public final class EngineCrashEvent implements Event { /** - * Constructor. + * Constructs this class. */ public EngineCrashEvent() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/EngineShutdownEvent.java b/base/src/main/java/de/staropensource/sosengine/base/events/EngineShutdownEvent.java index d6ba2f4..9bd1ec6 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/events/EngineShutdownEvent.java +++ b/base/src/main/java/de/staropensource/sosengine/base/events/EngineShutdownEvent.java @@ -29,7 +29,7 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper; */ public class EngineShutdownEvent implements Event { /** - * Constructor. + * Constructs this class. */ public EngineShutdownEvent() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/LogEvent.java b/base/src/main/java/de/staropensource/sosengine/base/events/LogEvent.java index 5a85500..7973ee1 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/events/LogEvent.java +++ b/base/src/main/java/de/staropensource/sosengine/base/events/LogEvent.java @@ -37,7 +37,7 @@ import java.lang.reflect.Method; @SuppressWarnings({ "unused" }) public final class LogEvent implements Event { /** - * Constructor. + * Constructs this class. */ public LogEvent() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java b/base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java index 6d36324..ff2a0b2 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java +++ b/base/src/main/java/de/staropensource/sosengine/base/events/ThrowableCatchEvent.java @@ -36,7 +36,7 @@ import java.lang.reflect.Method; */ public class ThrowableCatchEvent implements Event { /** - * Constructor. + * Constructs this class. */ public ThrowableCatchEvent() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/events/internal/InternalEngineShutdownEvent.java b/base/src/main/java/de/staropensource/sosengine/base/events/internal/InternalEngineShutdownEvent.java index 2dc2a05..0a7b8af 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/events/internal/InternalEngineShutdownEvent.java +++ b/base/src/main/java/de/staropensource/sosengine/base/events/internal/InternalEngineShutdownEvent.java @@ -29,7 +29,7 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper; */ public class InternalEngineShutdownEvent implements Event { /** - * Constructor. + * Constructs this class. */ public InternalEngineShutdownEvent() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/exceptions/DependencyCycleException.java b/base/src/main/java/de/staropensource/sosengine/base/exceptions/DependencyCycleException.java index ee2f6b2..bd47519 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/exceptions/DependencyCycleException.java +++ b/base/src/main/java/de/staropensource/sosengine/base/exceptions/DependencyCycleException.java @@ -29,7 +29,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public class DependencyCycleException extends Exception { /** - * Constructor. + * Constructs this exception. * * @param path cycle path * @since 1-alpha1 diff --git a/base/src/main/java/de/staropensource/sosengine/base/exceptions/InvalidVersionStringException.java b/base/src/main/java/de/staropensource/sosengine/base/exceptions/InvalidVersionStringException.java index a58d7b4..12620c5 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/exceptions/InvalidVersionStringException.java +++ b/base/src/main/java/de/staropensource/sosengine/base/exceptions/InvalidVersionStringException.java @@ -48,7 +48,7 @@ public class InvalidVersionStringException extends Exception { Throwable throwable; /** - * Constructor. + * Constructs this exception. * * @param versioningSystem versioning system that is unable to parse version strings * @param versionString version string {@code a} @@ -62,7 +62,7 @@ public class InvalidVersionStringException extends Exception { } /** - * Constructor. + * Constructs this exception. * * @param versioningSystem versioning system that is unable to parse version strings * @param versionString version string {@code a} @@ -75,7 +75,7 @@ public class InvalidVersionStringException extends Exception { } /** - * Constructor. + * Constructs this exception. * * @param versioningSystem versioning system that is unable to parse version strings * @param versionString version string {@code a} @@ -88,7 +88,7 @@ public class InvalidVersionStringException extends Exception { } /** - * Constructor. + * Constructs this exception. * * @param versioningSystem versioning system that is unable to parse version strings * @param versionString version string {@code a} diff --git a/base/src/main/java/de/staropensource/sosengine/base/exceptions/UnexpectedThrowableException.java b/base/src/main/java/de/staropensource/sosengine/base/exceptions/UnexpectedThrowableException.java index 14a08f5..51d8545 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/exceptions/UnexpectedThrowableException.java +++ b/base/src/main/java/de/staropensource/sosengine/base/exceptions/UnexpectedThrowableException.java @@ -47,7 +47,7 @@ public class UnexpectedThrowableException extends Exception { Throwable throwable; /** - * Constructor. + * Constructs this exception. * * @param throwable throwable * @param message message @@ -58,7 +58,7 @@ public class UnexpectedThrowableException extends Exception { } /** - * Constructor. + * Constructs this exception. * * @param throwable throwable */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/CrashHandler.java b/base/src/main/java/de/staropensource/sosengine/base/logging/CrashHandler.java index 91dd53b..4931938 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/CrashHandler.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/CrashHandler.java @@ -95,7 +95,7 @@ public final class CrashHandler { private static final LinkedHashMap<@NotNull Object, @NotNull Object> crashContent = new LinkedHashMap<>(); /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/DefaultLoggerImpl.java b/base/src/main/java/de/staropensource/sosengine/base/logging/DefaultLoggerImpl.java index 413a763..5610d4b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/DefaultLoggerImpl.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/DefaultLoggerImpl.java @@ -38,7 +38,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings("resource") public class DefaultLoggerImpl implements LoggerImpl { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/Logger.java b/base/src/main/java/de/staropensource/sosengine/base/logging/Logger.java index 3f14efa..ad2cef0 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/Logger.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/Logger.java @@ -111,7 +111,7 @@ public final class Logger { private static final List activeRules = new ArrayList<>(); /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/LoggerInstance.java b/base/src/main/java/de/staropensource/sosengine/base/logging/LoggerInstance.java index cbcfbb8..0607691 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/LoggerInstance.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/LoggerInstance.java @@ -46,7 +46,7 @@ public final class LoggerInstance { private final LogIssuer logIssuer; /** - * Constructor. + * Creates a logger instance. * * @param logIssuer information about the parent class * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/QueuedLogMessage.java b/base/src/main/java/de/staropensource/sosengine/base/logging/QueuedLogMessage.java index efd6a94..ab8d61f 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/QueuedLogMessage.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/QueuedLogMessage.java @@ -75,7 +75,7 @@ public class QueuedLogMessage { private final String message; /** - * Constructor. + * Creates a new queued log message. * * @param issuer log message issuer * @param level log message level diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerClass.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerClass.java index 371709d..968c950 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerClass.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerClass.java @@ -40,7 +40,7 @@ public final class IssuerClass implements Placeholder { private final LogIssuer logIssuer; /** - * Constructor. + * Constructs this class. * * @param logIssuer {@link LogIssuer} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerCodePart.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerCodePart.java index 2385256..b528010 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerCodePart.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerCodePart.java @@ -40,7 +40,7 @@ public final class IssuerCodePart implements Placeholder { private final LogIssuer logIssuer; /** - * Constructor. + * Constructs this class. * * @param logIssuer {@link LogIssuer} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerInfo.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerInfo.java index ae0a564..9682d1a 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerInfo.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerInfo.java @@ -40,7 +40,7 @@ public final class IssuerInfo implements Placeholder { private final LogIssuer logIssuer; /** - * Constructor. + * Constructs this class. * * @param logIssuer {@link LogIssuer} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerMessage.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerMessage.java index 4391ad4..cec9f6a 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerMessage.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerMessage.java @@ -39,7 +39,7 @@ public final class IssuerMessage implements Placeholder { private final String message; /** - * Constructor. + * Constructs this class. * * @param message message to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerPackage.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerPackage.java index dcc89b4..e9959a2 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerPackage.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerPackage.java @@ -40,7 +40,7 @@ public final class IssuerPackage implements Placeholder { private final LogIssuer logIssuer; /** - * Constructor. + * Constructs this class. * * @param logIssuer {@link LogIssuer} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerPath.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerPath.java index 9ee5513..330522b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerPath.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/IssuerPath.java @@ -40,7 +40,7 @@ public final class IssuerPath implements Placeholder { private final LogIssuer logIssuer; /** - * Constructor. + * Constructs this class. * * @param logIssuer {@link LogIssuer} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/Stacktrace.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/Stacktrace.java index 1ead79d..f7d8713 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/Stacktrace.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/crashhandler/Stacktrace.java @@ -41,7 +41,7 @@ public final class Stacktrace implements Placeholder { private final Throwable throwable; /** - * Constructor. + * Constructs this class. * * @param throwable {@link Throwable} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogClass.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogClass.java index e091aa0..fa9f9af 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogClass.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogClass.java @@ -40,7 +40,7 @@ public final class LogClass implements Placeholder { private final LogIssuer logIssuer; /** - * Constructor. + * Constructs this class. * * @param logIssuer {@link LogIssuer} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogCodePart.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogCodePart.java index cafce64..926c029 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogCodePart.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogCodePart.java @@ -40,7 +40,7 @@ public final class LogCodePart implements Placeholder { private final LogIssuer logIssuer; /** - * Constructor. + * Constructs this class. * * @param logIssuer {@link LogIssuer} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogColorPrimary.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogColorPrimary.java index 3c4bf3b..dc758fa 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogColorPrimary.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogColorPrimary.java @@ -40,7 +40,7 @@ public final class LogColorPrimary implements Placeholder { private final LogLevel level; /** - * Constructor. + * Constructs this class. * * @param level {@link LogLevel} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogColorSecondary.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogColorSecondary.java index 7079838..2167ee9 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogColorSecondary.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogColorSecondary.java @@ -40,7 +40,7 @@ public final class LogColorSecondary implements Placeholder { private final LogLevel level; /** - * Constructor. + * Constructs this class. * * @param level {@link LogLevel} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogInfo.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogInfo.java index b142639..1803fe0 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogInfo.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogInfo.java @@ -40,7 +40,7 @@ public final class LogInfo implements Placeholder { private final LogIssuer logIssuer; /** - * Constructor. + * Constructs this class. * * @param logIssuer {@link LogIssuer} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogLevel.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogLevel.java index 8738722..534b025 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogLevel.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogLevel.java @@ -39,7 +39,7 @@ public final class LogLevel implements Placeholder { private final de.staropensource.sosengine.base.classes.logging.LogLevel level; /** - * Constructor. + * Constructs this class. * * @param level {@link de.staropensource.sosengine.base.classes.logging.LogLevel} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogMessage.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogMessage.java index 7b7eafd..8a84ad3 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogMessage.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogMessage.java @@ -39,7 +39,7 @@ public final class LogMessage implements Placeholder { private final String message; /** - * Constructor. + * Constructs this class. * * @param message message to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogPackage.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogPackage.java index 7f904d2..ad77218 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogPackage.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogPackage.java @@ -40,7 +40,7 @@ public final class LogPackage implements Placeholder { private final LogIssuer logIssuer; /** - * Constructor. + * Constructs this class. * * @param logIssuer {@link LogIssuer} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogPath.java b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogPath.java index 2cf5333..0d820fb 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogPath.java +++ b/base/src/main/java/de/staropensource/sosengine/base/logging/placeholders/logger/LogPath.java @@ -40,7 +40,7 @@ public final class LogPath implements Placeholder { private final LogIssuer logIssuer; /** - * Constructor. + * Constructs this class. * * @param logIssuer {@link LogIssuer} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/DependencyVector.java b/base/src/main/java/de/staropensource/sosengine/base/types/DependencyVector.java index fb6f925..cc9da10 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/DependencyVector.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/DependencyVector.java @@ -90,7 +90,7 @@ public class DependencyVector { private final List<@NotNull String> dependencies; /** - * Constructor. + * Creates a new dependency vector. * * @param identifier identifier * @param versioningSystem versioning system to use @@ -105,7 +105,7 @@ public class DependencyVector { } /** - * Constructor. + * Creates a new dependency vector. * * @param identifier identifier * @param versioningSystem versioning system to use diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/ImmutableMap.java b/base/src/main/java/de/staropensource/sosengine/base/types/ImmutableMap.java index 56c3d87..6478910 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/ImmutableMap.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/ImmutableMap.java @@ -35,14 +35,14 @@ import java.util.function.BiFunction; @SuppressWarnings({ "unused" }) public class ImmutableMap extends HashMap { /** - * Constructor. + * Creates a new immutable map. * * @since 1-alpha1 */ public ImmutableMap() {} /** - * Converts some {@link Map} into a {@link ImmutableMap}. + * Converts a {@link Map} into a {@link ImmutableMap}. * * @param map {@link Map} to convert * @since 1-alpha1 diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/Vec2.java b/base/src/main/java/de/staropensource/sosengine/base/types/Vec2.java index ef12dea..cba132e 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/Vec2.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/Vec2.java @@ -70,7 +70,7 @@ public class Vec2 { private float y; /** - * Constructor. + * Creates a new 2D vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/Vec2i.java b/base/src/main/java/de/staropensource/sosengine/base/types/Vec2i.java index 09e89ce..ffbbf12 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/Vec2i.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/Vec2i.java @@ -70,7 +70,7 @@ public class Vec2i { private int y; /** - * Constructor. + * Creates a new 2D integer vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/Vec3.java b/base/src/main/java/de/staropensource/sosengine/base/types/Vec3.java index 2952cb7..034105f 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/Vec3.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/Vec3.java @@ -89,7 +89,7 @@ public class Vec3 { private float z; /** - * Constructor. + * Constructs this 3D vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/sosengine/base/types/Vec3i.java b/base/src/main/java/de/staropensource/sosengine/base/types/Vec3i.java index f84c6e2..0a17e2b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/types/Vec3i.java +++ b/base/src/main/java/de/staropensource/sosengine/base/types/Vec3i.java @@ -89,7 +89,7 @@ public class Vec3i { private int z; /** - * Constructor. + * Constructs this 3D integer vector. * * @param x X axis value * @param y Y axis value diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/DependencyResolver.java b/base/src/main/java/de/staropensource/sosengine/base/utility/DependencyResolver.java index 527f141..07ecac6 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/DependencyResolver.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/DependencyResolver.java @@ -45,7 +45,7 @@ public class DependencyResolver { List vectors = new ArrayList<>(); /** - * Constructor. + * Constructs this class. */ public DependencyResolver() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/ListFormatter.java b/base/src/main/java/de/staropensource/sosengine/base/utility/ListFormatter.java index f53b325..7f09707 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/ListFormatter.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/ListFormatter.java @@ -35,7 +35,7 @@ import java.util.Set; @SuppressWarnings({ "unused" }) public class ListFormatter { /** - * Constructor. + * Constructs this class. */ public ListFormatter() {} diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java b/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java index a1ecde2..472fe9c 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java @@ -38,7 +38,7 @@ import java.util.stream.Collectors; @SuppressWarnings({ "unused" }) public final class Miscellaneous { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/PlaceholderEngine.java b/base/src/main/java/de/staropensource/sosengine/base/utility/PlaceholderEngine.java index f6f58ca..7ddb20b 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/PlaceholderEngine.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/PlaceholderEngine.java @@ -19,6 +19,7 @@ package de.staropensource.sosengine.base.utility; +import de.staropensource.sosengine.base.Engine; import de.staropensource.sosengine.base.classes.Placeholder; import de.staropensource.sosengine.base.classes.logging.LogIssuer; import de.staropensource.sosengine.base.data.placeholder.*; @@ -39,14 +40,14 @@ import java.util.List; @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) public final class PlaceholderEngine { /** - * Instance. + * Contains the class instance. * * @since 1-alpha0 * * -- GETTER -- - * Returns the {@link PlaceholderEngine} instance. + * Returns the class instance. * - * @return {@link PlaceholderEngine} instance + * @return class instance unless {@link Engine} is uninitialized * @since 1-alpha0 */ @Getter @@ -69,7 +70,7 @@ public final class PlaceholderEngine { private List<@NotNull Placeholder> placeholders = new ArrayList<>(); /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/PropertyParser.java b/base/src/main/java/de/staropensource/sosengine/base/utility/PropertyParser.java index 1592900..c942dfb 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/PropertyParser.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/PropertyParser.java @@ -19,10 +19,10 @@ package de.staropensource.sosengine.base.utility; -import de.staropensource.sosengine.base.types.Tristate; +import de.staropensource.sosengine.base.classes.logging.LogIssuer; import de.staropensource.sosengine.base.logging.LoggerInstance; import de.staropensource.sosengine.base.types.CodePart; -import de.staropensource.sosengine.base.classes.logging.LogIssuer; +import de.staropensource.sosengine.base.types.Tristate; import lombok.Getter; import org.jetbrains.annotations.NotNull; @@ -38,15 +38,15 @@ import java.util.Properties; @NotNull public class PropertyParser { /** - * Instance providing access to the JVM-wide properties. + * Contains an instance providing access to the JVM-wide properties. * * @see System#getProperties() * @since 1-alpha0 * * -- GETTER -- - * Returns a {@link Properties} instance providing access to the JVM-wide properties. + * Returns an instance providing access to the JVM-wide properties. * - * @return {@link Properties} using the JVM-wide properties + * @return instance using the JVM-wide properties * @see System#getProperties() * @since 1-alpha0 */ @@ -80,7 +80,7 @@ public class PropertyParser { private final LoggerInstance logger; /** - * Constructor. + * Creates a new {@link Properties} parser. * * @param properties {@link Properties} to use * @since 1-alpha0 diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/ShortcodeConverter.java b/base/src/main/java/de/staropensource/sosengine/base/utility/ShortcodeConverter.java index 3fead00..c1b29ea 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/ShortcodeConverter.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/ShortcodeConverter.java @@ -19,11 +19,12 @@ package de.staropensource.sosengine.base.utility; +import de.staropensource.sosengine.base.Engine; import de.staropensource.sosengine.base.EngineConfiguration; +import de.staropensource.sosengine.base.classes.logging.LogIssuer; import de.staropensource.sosengine.base.logging.Logger; import de.staropensource.sosengine.base.logging.LoggerInstance; import de.staropensource.sosengine.base.types.CodePart; -import de.staropensource.sosengine.base.classes.logging.LogIssuer; import lombok.Getter; import org.fusesource.jansi.Ansi; import org.jetbrains.annotations.NotNull; @@ -40,14 +41,14 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) public class ShortcodeConverter { /** - * Instance. + * Contains the class instance. * * @since 1-alpha0 * * -- GETTER -- - * Returns the {@link ShortcodeConverter} instance. + * Returns the class instance. * - * @return {@link ShortcodeConverter} instance + * @return class instance unless {@link Engine} is uninitialized * @since 1-alpha0 */ @Getter @@ -62,7 +63,7 @@ public class ShortcodeConverter { private final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.ENGINE)); /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/StackTraceParser.java b/base/src/main/java/de/staropensource/sosengine/base/utility/StackTraceParser.java index 0d55626..3a258ec 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/utility/StackTraceParser.java +++ b/base/src/main/java/de/staropensource/sosengine/base/utility/StackTraceParser.java @@ -47,7 +47,7 @@ public class StackTraceParser { private final @NotNull Throwable throwable; /** - * Constructor. + * Constructs this class. * * @param throwable throwable to use * @since 1-alpha0 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 f41f174..0a8212a 100644 --- a/base/src/main/java/de/staropensource/sosengine/unittests/UnitConfig.java +++ b/base/src/main/java/de/staropensource/sosengine/unittests/UnitConfig.java @@ -28,7 +28,7 @@ import de.staropensource.sosengine.base.classes.logging.LogLevel; */ public class UnitConfig { /** - * Constructor. + * Constructs this class. * * @since 1-alpha0 */ 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 7adc6ba..e8a7d57 100644 --- a/base/src/main/java/de/staropensource/sosengine/unittests/UnitLogger.java +++ b/base/src/main/java/de/staropensource/sosengine/unittests/UnitLogger.java @@ -40,7 +40,7 @@ public class UnitLogger { private final Class clazz; /** - * Constructor. + * Creates a new unit logger. * * @param clazz parent class * @since 1-alpha0 diff --git a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlManagement.java b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlManagement.java index 2b97212..f406bc6 100644 --- a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlManagement.java +++ b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlManagement.java @@ -32,7 +32,7 @@ import org.jetbrains.annotations.NotNull; @SuppressWarnings({ "unused" }) public final class OpenGlManagement implements ApiManagementClass { /** - * Constructor. + * Constructs this class. */ public OpenGlManagement() {} diff --git a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlSubsystem.java b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlSubsystem.java index e0d1c20..0084d3b 100644 --- a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlSubsystem.java +++ b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/OpenGlSubsystem.java @@ -50,14 +50,14 @@ import static org.lwjgl.glfw.GLFW.*; @EngineSubsystem public final class OpenGlSubsystem implements ApiMainClass { /** - * Instance. + * Contains the class instance. * * @since 1-alpha0 * * -- GETTER -- - * Returns the {@link OpenGlSubsystem} instance. + * Returns the class instance. * - * @return {@link OpenGlSubsystem} instance unless uninitialized + * @return class instance unless the subsystem is uninitialized * @since 1-alpha0 */ @Getter @@ -84,7 +84,7 @@ public final class OpenGlSubsystem implements ApiMainClass { private ApiManagementClass management; /** - * Constructor. + * Constructs this subsystem. * * @since 1-alpha0 */ diff --git a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/classes/Window.java b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/classes/Window.java index 835e938..91dee68 100644 --- a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/classes/Window.java +++ b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/classes/Window.java @@ -91,7 +91,7 @@ public class Window implements de.staropensource.sosengine.graphics.classes.Wind private Vec2i windowSize; /** - * Constructor. Creates a new window. + * Creates a new window. * * @param title window title * @param size window size diff --git a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/events/GraphicsErrorEvent.java b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/events/GraphicsErrorEvent.java index c3c4d11..cc2618b 100644 --- a/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/events/GraphicsErrorEvent.java +++ b/graphics/opengl/src/main/java/de/staropensource/sosengine/graphics/opengl/events/GraphicsErrorEvent.java @@ -29,7 +29,7 @@ import org.lwjgl.glfw.GLFWErrorCallbackI; @SuppressWarnings({ "unused" }) public class GraphicsErrorEvent extends de.staropensource.sosengine.graphics.events.GraphicsErrorEvent implements GLFWErrorCallbackI { /** - * Constructor. + * Constructs this class. */ public GraphicsErrorEvent() {} diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystem.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystem.java index 0dc1f2f..fc39684 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystem.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystem.java @@ -53,14 +53,14 @@ import java.util.Map; @EngineSubsystem public final class GraphicsSubsystem implements SubsystemMainClass { /** - * Instance. + * Contains the class instance. * * @since 1-alpha0 * * -- GETTER -- - * Returns the {@link GraphicsSubsystem} instance. + * Returns the class instance. * - * @return {@link GraphicsSubsystem} instance unless uninitialized + * @return class instance unless the subsystem is uninitialized * @since 1-alpha0 */ @Getter @@ -108,7 +108,7 @@ public final class GraphicsSubsystem implements SubsystemMainClass { private ApiMainClass api = null; /** - * Constructor. + * Constructs this subsystem. * * @since 1-alpha0 */ diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystemConfiguration.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystemConfiguration.java index b007e65..199ee30 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystemConfiguration.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/GraphicsSubsystemConfiguration.java @@ -40,14 +40,14 @@ import java.util.Properties; @Getter public final class GraphicsSubsystemConfiguration implements SubsystemConfiguration { /** - * Instance. + * Contains the class instance. * * @since 1-alpha0 * * -- GETTER -- - * Returns the {@link GraphicsSubsystemConfiguration} instance. + * Returns the class instance. * - * @return {@link GraphicsSubsystemConfiguration} instance + * @return class instance unless {@link GraphicsSubsystem} is uninitialized * @since 1-alpha0 */ @Getter @@ -99,7 +99,7 @@ public final class GraphicsSubsystemConfiguration implements SubsystemConfigurat private boolean errorGraphicsError; /** - * Constructor. + * Constructs this class. * * @see GraphicsSubsystem * @since 1-alpha0 diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiErrorEvent.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiErrorEvent.java index 18b1d9e..fcb70ab 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiErrorEvent.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiErrorEvent.java @@ -37,7 +37,7 @@ import java.lang.reflect.Method; @SuppressWarnings({ "unused" }) public class GraphicsApiErrorEvent implements Event { /** - * Constructor. + * Constructs this class. */ public GraphicsApiErrorEvent() {} diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiShutdownEvent.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiShutdownEvent.java index e1e945b..3b742bf 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiShutdownEvent.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsApiShutdownEvent.java @@ -30,7 +30,7 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper; @SuppressWarnings({ "unused" }) public class GraphicsApiShutdownEvent implements Event { /** - * Constructor. + * Constructs this class. */ public GraphicsApiShutdownEvent() {} diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsErrorEvent.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsErrorEvent.java index e2614a1..0c35f91 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsErrorEvent.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/events/GraphicsErrorEvent.java @@ -37,7 +37,7 @@ import java.lang.reflect.Method; @SuppressWarnings({ "unused" }) public class GraphicsErrorEvent implements Event { /** - * Constructor. + * Constructs this class. */ public GraphicsErrorEvent() {} diff --git a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanManagement.java b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanManagement.java index cad166a..884cb83 100644 --- a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanManagement.java +++ b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanManagement.java @@ -29,9 +29,10 @@ import org.jetbrains.annotations.NotNull; * * @since 1-alpha0 */ +@SuppressWarnings({ "unused" }) public class VulkanManagement implements ApiManagementClass { /** - * Constructor. + * Constructs this class. */ public VulkanManagement() {} diff --git a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanSubsystem.java b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanSubsystem.java index b122363..acaba87 100644 --- a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanSubsystem.java +++ b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/VulkanSubsystem.java @@ -47,14 +47,14 @@ import static org.lwjgl.glfw.GLFW.*; @EngineSubsystem public final class VulkanSubsystem implements ApiMainClass { /** - * Instance. + * Contains the class instance. * * @since 1-alpha0 * * -- GETTER -- - * Returns the {@link VulkanSubsystem} instance. + * Returns the class instance. * - * @return {@link VulkanSubsystem} instance unless uninitialized + * @return class instance unless the subsystem is uninitialized * @since 1-alpha0 */ @Getter @@ -81,7 +81,7 @@ public final class VulkanSubsystem implements ApiMainClass { private ApiManagementClass management; /** - * Constructor. + * Constructs this subsystem. * * @since 1-alpha0 */ diff --git a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/events/GraphicsErrorEvent.java b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/events/GraphicsErrorEvent.java index dd0fef0..c218ab0 100644 --- a/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/events/GraphicsErrorEvent.java +++ b/graphics/vulkan/src/main/java/de/staropensource/sosengine/graphics/vulkan/events/GraphicsErrorEvent.java @@ -29,7 +29,7 @@ import org.lwjgl.glfw.GLFWErrorCallbackI; @SuppressWarnings({ "unused" }) public class GraphicsErrorEvent extends de.staropensource.sosengine.graphics.events.GraphicsErrorEvent implements GLFWErrorCallbackI { /** - * Constructor. + * Constructs this class. */ public GraphicsErrorEvent() {} diff --git a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLogger.java b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLogger.java index d5a40f1..2f423f3 100644 --- a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLogger.java +++ b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLogger.java @@ -21,10 +21,10 @@ package de.staropensource.sosengine.slf4j_compat; import de.staropensource.sosengine.base.Engine; import de.staropensource.sosengine.base.EngineConfiguration; -import de.staropensource.sosengine.base.logging.LoggerInstance; -import de.staropensource.sosengine.base.types.CodePart; import de.staropensource.sosengine.base.classes.logging.LogIssuer; import de.staropensource.sosengine.base.classes.logging.LogLevel; +import de.staropensource.sosengine.base.logging.LoggerInstance; +import de.staropensource.sosengine.base.types.CodePart; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; import org.slf4j.Marker; @@ -97,6 +97,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * Returns the fully qualified caller name. * * @return null + * @since 1-alpha0 */ @Nullable @Override @@ -109,6 +110,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @return {@code LogLevel.DIAGNOSTIC} status * @see LogLevel#DIAGNOSTIC + * @since 1-alpha0 */ public boolean isTraceEnabled() { return isLevelAllowed(LogLevel.DIAGNOSTIC); @@ -119,6 +121,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @return {@code LogLevel.VERBOSE} status * @see LogLevel#VERBOSE + * @since 1-alpha0 */ public boolean isDebugEnabled() { return isLevelAllowed(LogLevel.VERBOSE); @@ -129,6 +132,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @return {@code LogLevel.INFORMATIONAL} status * @see LogLevel#INFORMATIONAL + * @since 1-alpha0 */ public boolean isInfoEnabled() { return isLevelAllowed(LogLevel.INFORMATIONAL); @@ -139,6 +143,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @return {@code LogLevel.WARNING} status * @see LogLevel#WARNING + * @since 1-alpha0 */ public boolean isWarnEnabled() { return isLevelAllowed(LogLevel.WARNING); @@ -149,6 +154,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @return {@code LogLevel.ERROR} status * @see LogLevel#ERROR + * @since 1-alpha0 */ public boolean isErrorEnabled() { return isLevelAllowed(LogLevel.ERROR); @@ -163,6 +169,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * @param arguments array of arguments to be formatted, may be null * @param throwable exception whose stack trace should be logged, may be null * @see CompatibilityLogger#forwardLogCall(Level, String, Object[], Throwable) + * @since 1-alpha0 */ @Override protected void handleNormalizedLoggingCall(Level level, Marker marker, String messagePattern, Object[] arguments, Throwable throwable) { @@ -170,9 +177,11 @@ public class CompatibilityLogger extends LegacyAbstractLogger { } /** - * Logs something? + * Just redirects to {@code forwardLogCall} * * @param event a {@link LoggingEvent} + * @see CompatibilityLogger#forwardLogCall(Level, String, Object[], Throwable) + * @since 1-alpha0 */ @SuppressWarnings("unused") public void log(@NotNull LoggingEvent event) { @@ -185,6 +194,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * * @param level log level to check * @return whether the logger is enabled for the given level + * @since 1-alpha0 */ protected boolean isLevelAllowed(LogLevel level) { if (Engine.getInstance() == null || EngineConfiguration.getInstance() == null) @@ -200,6 +210,7 @@ public class CompatibilityLogger extends LegacyAbstractLogger { * @param pattern message pattern * @param arguments unused * @param throwable throwable + * @since 1-alpha0 */ private void forwardLogCall(Level level, String pattern, Object[] arguments, Throwable throwable) { String message = MessageFormatter.basicArrayFormat(pattern, arguments); diff --git a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerFactory.java b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerFactory.java index 6ea26e7..669da45 100644 --- a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerFactory.java +++ b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerFactory.java @@ -28,13 +28,17 @@ import java.util.concurrent.ConcurrentMap; /** * A factory for {@link CompatibilityLogger}. + * + * @since 1-alpha0 */ @SuppressWarnings({ "unused", "JavadocBlankLines" }) public class CompatibilityLoggerFactory implements ILoggerFactory { ConcurrentMap<@NotNull String, @NotNull Logger> loggerMap; /** - * Constructor. + * Constructs this class. + * + * @since 1-alpha0 */ public CompatibilityLoggerFactory() { loggerMap = new ConcurrentHashMap<>(); @@ -46,6 +50,8 @@ public class CompatibilityLoggerFactory implements ILoggerFactory { * * This method will call {@link #createLogger(String)} if the logger * has not been created yet. + * + * @since 1-alpha0 */ public Logger getLogger(String name) { return loggerMap.computeIfAbsent(name, this::createLogger); @@ -53,6 +59,8 @@ public class CompatibilityLoggerFactory implements ILoggerFactory { /** * Actually creates the logger for the given name. + * + * @since 1-alpha0 */ protected Logger createLogger(String name) { return new CompatibilityLogger(name); diff --git a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerProvider.java b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerProvider.java index 119dd77..2320dd7 100644 --- a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerProvider.java +++ b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/CompatibilityLoggerProvider.java @@ -43,6 +43,8 @@ public class CompatibilityLoggerProvider implements SLF4JServiceProvider { * * -- GETTER -- * {@inheritDoc} + * + * @since 1-alpha0 */ public String requestedApiVersion = "2.0.99"; @@ -70,11 +72,15 @@ public class CompatibilityLoggerProvider implements SLF4JServiceProvider { * * -- GETTER -- * {@inheritDoc} + * + * @since 1-alpha0 */ private MDCAdapter mDCAdapter; /** - * Constructor. + * Constructs this class. + * + * @since 1-alpha0 */ public CompatibilityLoggerProvider() {} diff --git a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/Slf4jCompatibilitySubsystem.java b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/Slf4jCompatibilitySubsystem.java index 1722d70..1e78b71 100644 --- a/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/Slf4jCompatibilitySubsystem.java +++ b/slf4j-compat/src/main/java/de/staropensource/sosengine/slf4j_compat/Slf4jCompatibilitySubsystem.java @@ -41,14 +41,14 @@ import org.slf4j.LoggerFactory; @EngineSubsystem public class Slf4jCompatibilitySubsystem implements SubsystemMainClass { /** - * Instance. + * Contains the class instance. * * @since 1-alpha0 * * -- GETTER -- - * Returns the {@link Slf4jCompatibilitySubsystem} instance. + * Returns the class instance. * - * @return {@link Slf4jCompatibilitySubsystem} instance unless uninitialized + * @return class instance unless the subsystem is uninitialized * @since 1-alpha0 */ @Getter @@ -58,7 +58,7 @@ public class Slf4jCompatibilitySubsystem implements SubsystemMainClass { private final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.ENGINE)); /** - * Constructor. + * Constructs this subsystem. */ public Slf4jCompatibilitySubsystem() { // Check if subsystem has already initialized diff --git a/testapp/src/main/java/de/staropensource/sosengine/testapp/Main.java b/testapp/src/main/java/de/staropensource/sosengine/testapp/Main.java index 5cd59b0..a1169d1 100644 --- a/testapp/src/main/java/de/staropensource/sosengine/testapp/Main.java +++ b/testapp/src/main/java/de/staropensource/sosengine/testapp/Main.java @@ -36,12 +36,15 @@ import lombok.SneakyThrows; @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) public class Main { /** - * Instance. + * Contains the class instance. + * + * @since 1-alpha0 * * -- GETTER -- - * Returns the {@link Main} instance. + * Returns the class instance. * - * @return {@link Main} instance + * @return class instance + * @since 1-alpha0 */ @Getter private static final Main instance = new Main(); @@ -68,7 +71,7 @@ public class Main { private final LoggerInstance logger = new LoggerInstance(new LogIssuer(getClass(), CodePart.APPLICATION)); /** - * Constructor. + * Constructs this class. */ public Main() {}