diff --git a/pom.xml b/pom.xml index 7e54c52..d1a0f85 100644 --- a/pom.xml +++ b/pom.xml @@ -63,6 +63,7 @@ org.apache.maven.plugins maven-source-plugin + 3.2.1 attach-sources @@ -75,6 +76,7 @@ org.apache.maven.plugins maven-javadoc-plugin + 3.2.0 attach-javadocs diff --git a/src/main/java/dev/kske/eventbus/Event.java b/src/main/java/dev/kske/eventbus/Event.java index ebfb0b9..95fb2d3 100644 --- a/src/main/java/dev/kske/eventbus/Event.java +++ b/src/main/java/dev/kske/eventbus/Event.java @@ -10,11 +10,12 @@ import java.lang.annotation.*; * comply with the following specifications: *
    *
  • Declared inside a class that implements {@link EventListener}
  • - *
  • Specifying an event type by either
  • + *
  • Specifying an event type by either *
      *
    • Declaring one parameter of a type that implements {@link IEvent}
    • *
    • Defining the class of the event using the {@link Event#eventType()} value
    • *
    + *
  • *
  • Return type of {@code void}
  • *
* @@ -32,6 +33,7 @@ public @interface Event { *

* The execution order of handlers with the same priority is undefined. * + * @return the priority of the event handler * @since 0.0.1 */ int priority() default 100; @@ -39,6 +41,7 @@ public @interface Event { /** * Defines whether instances of subtypes of the event type are dispatched to the event handler. * + * @return whether the event handler includes subtypes * @since 0.0.4 */ boolean includeSubtypes() default false; @@ -49,6 +52,7 @@ public @interface Event { *

* This is useful when the event handler does not utilize the event instance. * + * @return the event type accepted by the handler * @since 0.0.3 */ Class eventType() default USE_PARAMETER.class;