Improve Documentation in Code #24

Merged
kske merged 2 commits from f/improved-documentation into develop 2021-11-01 21:48:51 +01:00
There is no content yet.
kske self-assigned this 2021-11-01 09:43:31 +01:00
kske added 1 commit 2021-11-01 09:43:32 +01:00
kske requested review from delvh 2021-11-01 09:43:48 +01:00
kske requested review from mpk 2021-11-01 09:43:48 +01:00
delvh requested changes 2021-11-01 16:09:31 +01:00
@ -74,0 +75,4 @@
private final Map<Class<?>, TreeSet<EventHandler>> bindings = new ConcurrentHashMap<>();
/**
* Registered listeners.

Stores all registered listeners. Additionally prevents them from being garbage collected.

Stores all registered listeners. Additionally prevents them from being garbage collected.
kske marked this conversation as resolved
@ -74,0 +82,4 @@
private final Set<Object> registeredListeners = ConcurrentHashMap.newKeySet();
/**
* Thread-local dispatch state.

The current event dispatching state for the current thread.

The current event dispatching state for the current thread.
kske marked this conversation as resolved
@ -4,3 +4,1 @@
* This runtime exception is thrown when an event bus error occurs. This can
* either occur while registering event listeners with invalid handlers, or when
* an event handler throws an exception.
* This unchecked exception is specific to the event bus and can be thrown under the following

I think it would be kinda funny to have an EventBusException that can be thrown under (the bus and) the following…

I think it would be kinda funny to have an `EventBusException` that `can be thrown under (the bus and) the following…`
@ -7,0 +4,4 @@
* This unchecked exception is specific to the event bus and can be thrown under the following
* circumstances:
* <ul>
* <li>An event handler throws an exception (which is stores as the cause)</li>

it

Alternatively:
stored

it Alternatively: stored
kske marked this conversation as resolved
kske added 1 commit 2021-11-01 20:52:20 +01:00
kske requested review from delvh 2021-11-01 20:52:43 +01:00
mpk approved these changes 2021-11-01 21:48:44 +01:00
kske merged commit 40d48cb959 into develop 2021-11-01 21:48:51 +01:00
kske deleted branch f/improved-documentation 2021-11-01 21:48:51 +01:00
Sign in to join this conversation.
No reviewers
No Milestone
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: zdm/event-bus#24
There is no content yet.