Make javadoc happy

base/src/main/java/de/staropensource/sosengine/base/EngineConfiguration.java

@@ -39,11 +39,31 @@ import java.util.Properties;
 @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
 @Getter
 public final class EngineConfiguration implements SubsystemConfiguration {
-    /** {@inheritDoc} */
+    /**
+     * Instance.
+     *
+     * @since 1-alpha0
+     *
+     * -- GETTER --
+     * Returns the {@link EngineConfiguration} instance.
+     *
+     * @return {@link EngineConfiguration} instance
+     * @since 1-alpha0
+     */
     @Getter
     private static EngineConfiguration instance;
 
-    /** {@inheritDoc} */
+    /**
+     * Defines the group every property must start with to be recognized as a subsystem configuration setting.
+     *
+     * @since 1-alpha0
+     *
+     * -- GETTER --
+     * Returns the group that every property must start with to be recognized as a subsystem configuration setting.
+     *
+     * @return property group
+     * @since 1-alpha0
+     */
     @Getter
     private static final String group = "sosengine.base.";
 

base/src/main/java/de/staropensource/sosengine/base/classes/SubsystemConfiguration.java

@@ -34,12 +34,6 @@ public interface SubsystemConfiguration {
      * Instance.
      *
      * @since 1-alpha0
-     *
-     * -- GETTER --
-     * Returns the {@link SubsystemConfiguration}-extending instance.
-     *
-     * @return {@link SubsystemConfiguration}-extending instance
-     * @since 1-alpha0
      */
     SubsystemConfiguration instance = null;
 
@@ -47,12 +41,6 @@ public interface SubsystemConfiguration {
      * Defines the group every property must start with to be recognized as a subsystem configuration setting.
      *
      * @since 1-alpha0
-     *
-     * -- GETTER --
-     * Returns the group every property must start with to be recognized as a subsystem configuration setting.
-     *
-     * @return the property group
-     * @since 1-alpha0
      */
     String group = "sosengine.";
 

base/src/main/java/de/staropensource/sosengine/base/classes/helpers/EventHelper.java

@@ -40,9 +40,16 @@ import java.util.*;
 @Getter
 @SuppressWarnings({ "unused" })
 public class EventHelper {
+    /**
+     * Constructor.
+     */
+    public EventHelper() {}
+
+
     /**
      * Returns all annotated methods.
      *
+     * @param clazz event class
      * @return list of annotated methods
      * @since 1-alpha0
      */
@@ -70,6 +77,7 @@ public class EventHelper {
     /**
      * Invokes all annotated methods without any arguments.
      *
+     * @param clazz event class
      * @since 1-alpha0
      */
     public static void invokeAnnotatedMethods(Class<? extends Event> clazz) {

base/src/main/java/de/staropensource/sosengine/base/events/EngineCrashEvent.java

@@ -29,6 +29,11 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper;
  */
 @SuppressWarnings({ "unused" })
 public final class EngineCrashEvent implements Event {
+    /**
+     * Constructor.
+     */
+    public EngineCrashEvent() {}
+
     /** {@inheritDoc} */
     @Override
     public void callEvent() {

base/src/main/java/de/staropensource/sosengine/base/events/EngineShutdownEvent.java

@@ -28,6 +28,11 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper;
  * @since 1-alpha0
  */
 public class EngineShutdownEvent implements Event {
+    /**
+     * Constructor.
+     */
+    public EngineShutdownEvent() {}
+
     /** {@inheritDoc} */
     @Override
     public void callEvent() {

base/src/main/java/de/staropensource/sosengine/base/events/LogEvent.java

@@ -35,6 +35,11 @@ import java.lang.reflect.Method;
  */
 @SuppressWarnings({ "unused" })
 public final class LogEvent implements Event {
+    /**
+     * Constructor.
+     */
+    public LogEvent() {}
+
     /**
      * {@inheritDoc}
      * @deprecated use the {@code callEvent} method with arguments

base/src/main/java/de/staropensource/sosengine/base/events/internal/InternalEngineShutdownEvent.java

@@ -28,6 +28,12 @@ import de.staropensource.sosengine.base.classes.helpers.EventHelper;
  * @since 1-alpha0
  */
 public class InternalEngineShutdownEvent implements Event {
+    /**
+     * Constructor.
+     */
+    public InternalEngineShutdownEvent() {}
+
+
     /** {@inheritDoc} */
     @Override
     public void callEvent() {

base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java

@@ -67,6 +67,7 @@ public final class Miscellaneous {
      * Measures the execution time of a {@link Runnable}.
      *
      * @param runnable the {@link Runnable} to execute
+     * @return execution time in milliseconds
      * @see Runnable
      * @since 1-alpha0
      */

base/src/main/java/de/staropensource/sosengine/unittests/UnitConfig.java

@@ -25,6 +25,11 @@ import de.staropensource.sosengine.base.types.LogLevel;
  * Static configuration for the sos!engine unit testing helpers.
  */
 public class UnitConfig {
+    /**
+     * Constructor.
+     */
+    public UnitConfig() {}
+
     /**
      * Configures the {@link LogLevel} for the {@link UnitLogger}.<br/>
      * Note: The log level {@code SILENT_WARNING} is used for printing test calls.

base/src/main/java/de/staropensource/sosengine/unittests/UnitLogger.java

@@ -110,7 +110,8 @@ public class UnitLogger {
     /**
      * Prints a test call message.
      *
-     * @param methodName the name of the test method called
+     * @param methodName name of the test method called
+     * @param methodArgs arguments of the test method called
      */
     public void testCall(@NotNull String methodName, @Nullable Object ... methodArgs) {
         log(LogLevel.SILENT_WARNING, methodName, List.of(methodArgs));