Skip to content

Commit

Permalink
Update Javadocs in EventBus.java
Browse files Browse the repository at this point in the history
Signed-off-by: 7orivorian <7orivorian+github@gmail.com>
  • Loading branch information
7orivorian committed Oct 18, 2023
1 parent a584a57 commit c6b2b3e
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions src/main/java/me/tori/wraith/bus/EventBus.java
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public class EventBus implements TargetableEventBus, InvertableEventBus {
* a mechanism to associate event classes with queues of tasks and ensures their orderly execution when the
* corresponding events are dispatched.
*
* @see #scheduleTask(Class, Runnable)
* @see #scheduleTask(ScheduledTask)
*/
private final TaskExecutor taskExecutor;

Expand Down Expand Up @@ -359,9 +359,10 @@ public void clearTaskExecutor() {
}

/**
* Logs a warning message and shuts down this event bus, preventing future events from being dispatched
* Logs a warning message and shuts down this event bus, preventing future events from being dispatched.
*
* @see #shutdown
* @implNote Shut-down event dispatchers cannot dispatch events, and throw {@link UnsupportedOperationException}
* when attempting to do so.
*/
@Override
public void shutdown() {
Expand All @@ -371,7 +372,8 @@ public void shutdown() {

/**
* @return {@code true} if this event bus is shut down
* @see #shutdown
* @implNote Shut-down event dispatchers cannot dispatch events, and throw {@link UnsupportedOperationException}
* when attempting to do so.
*/
@Override
public boolean isShutdown() {
Expand All @@ -380,7 +382,7 @@ public boolean isShutdown() {

/**
* Checks if this event bus is equal to another object.
* <p>If the given object is an event bus, it is only considered equal if {@code this.id == that.id}
* <p>If the given object is an event bus, it is only considered equal if {@code this.id == that.id}.
*
* @param o the object to compare with
* @return {@code true} if the object is equal to this event bus, {@code false} otherwise
Expand Down

0 comments on commit c6b2b3e

Please sign in to comment.