From 796eb9c8f9e49fdfb518af9e02aae3c22ff4bb56 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Sat, 21 Sep 2024 21:01:57 +0200 Subject: [PATCH] Fix Javadoc API generation warnings and errors --- .../sosengine/base/implementable/EventListenerCode.java | 8 ++++++++ .../base/internal/implementation/EventListenerMethod.java | 2 ++ .../de/staropensource/sosengine/base/type/Tristate.java | 1 + 3 files changed, 11 insertions(+) diff --git a/base/src/main/java/de/staropensource/sosengine/base/implementable/EventListenerCode.java b/base/src/main/java/de/staropensource/sosengine/base/implementable/EventListenerCode.java index 4a9c907f..5fa471f3 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/implementable/EventListenerCode.java +++ b/base/src/main/java/de/staropensource/sosengine/base/implementable/EventListenerCode.java @@ -41,10 +41,18 @@ public abstract class EventListenerCode { */ public @NotNull EventPriority priority = EventPriority.DEFAULT; + /** + * Constructs this class. + * + * @since v1-alpha5 + */ + public EventListenerCode() {} + /** * Invokes the event listener. * * @param arguments arguments passed along by the event + * @throws Exception exceptions thrown * @since v1-alpha5 */ public abstract void run(Object... arguments) throws Exception; diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/implementation/EventListenerMethod.java b/base/src/main/java/de/staropensource/sosengine/base/internal/implementation/EventListenerMethod.java index 09d5468c..da9024e6 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/implementation/EventListenerMethod.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/implementation/EventListenerMethod.java @@ -44,6 +44,7 @@ public final class EventListenerMethod extends EventListenerCode { /** * Constructs this class. * + * @param method method to execute * @since v1-alpha0 */ public EventListenerMethod(@NotNull Method method) { @@ -60,6 +61,7 @@ public final class EventListenerMethod extends EventListenerCode { * Forwards {@link ReflectionMethod#getAnnotation(Class)} * to the internal {@link ReflectionMethod} instance. * + * @param annotation * @param annotation annotation to get * @return annotation or {@code null} on error * @see ReflectionMethod#getAnnotation(Class) diff --git a/base/src/main/java/de/staropensource/sosengine/base/type/Tristate.java b/base/src/main/java/de/staropensource/sosengine/base/type/Tristate.java index e7862ace..b8941753 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/type/Tristate.java +++ b/base/src/main/java/de/staropensource/sosengine/base/type/Tristate.java @@ -52,6 +52,7 @@ public enum Tristate { /** * Converts the {@link Boolean} into a {@link Tristate}. * + * @param bool boolean to convert * @return tristated boolean * @since v1-alpha5 */