Skip to content

Commit a6b707b

Browse files
committed
docs: clarify fastbus entry point
1 parent a76cd29 commit a6b707b

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

src/main/java/re/tsuku/fastbus/FastBus.java

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,16 @@
2323
import java.util.concurrent.atomic.AtomicLong;
2424

2525
/**
26-
* a small typed event bus.
26+
* main event bus for subscribing listeners and posting events.
2727
*
2828
* <p>
29-
* subscriptions are indexed by event type. posting uses a cached immutable handler snapshot for the concrete event
30-
* class, so dispatch does not scan unrelated listeners.
29+
* listeners can be registered directly with {@link #subscribe(Class, Listener)} or discovered from an object with
30+
* {@link Subscribe} methods and fields using {@link #subscribe(Object)}.
31+
* </p>
32+
*
33+
* <p>
34+
* subscriptions are indexed by event type. posting uses cached immutable listener snapshots for the concrete event
35+
* class, so dispatch stays on the matching listener set.
3136
* </p>
3237
*/
3338
public final class FastBus {

0 commit comments

Comments
 (0)