Make javadoc happy

This commit is contained in:
JeremyStar™ 2024-06-10 21:51:10 +02:00
parent e9c44d903e
commit 78154962ef
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
10 changed files with 59 additions and 15 deletions

View file

@ -39,11 +39,31 @@ import java.util.Properties;
@SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" }) @SuppressWarnings({ "unused", "JavadocDeclaration", "JavadocBlankLines" })
@Getter @Getter
public final class EngineConfiguration implements SubsystemConfiguration { 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 @Getter
private static EngineConfiguration instance; 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 @Getter
private static final String group = "sosengine.base."; private static final String group = "sosengine.base.";

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -110,7 +110,8 @@ public class UnitLogger {
/** /**
* Prints a test call message. * 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) { public void testCall(@NotNull String methodName, @Nullable Object ... methodArgs) {
log(LogLevel.SILENT_WARNING, methodName, List.of(methodArgs)); log(LogLevel.SILENT_WARNING, methodName, List.of(methodArgs));