Skip to content

Commit

Permalink
Fix typos and update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
LexManos committed Mar 1, 2024
1 parent ec01e75 commit dc0fbc7
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# EventBus

EventBus is designed to be a simple subscriber-publisher framework. Originally inspired by [Guava], with intentions to be faster by replacing reflection with generated accessor classes. EventBus is intended to be a generic library usable in any project. It has grown larger API/Feature/Complexity/Dependency wise then it was ever intended, and thus will be receiving some redesigns and simplification eventually.

The major focus of EventBus is fast event dispatching. As such any changes should have benchmarks run. See [Benchmarking].

### Thanks
[![YourKit](https://www.yourkit.com/images/yklogo.png)](https://www.yourkit.com/)

YourKit for providing us access to their [YourKit Java Profiler] which helps identify bottlenecks and places for improvment.


[Guava]: https://guava.dev/releases/snapshot-jre/api/docs/com/google/common/eventbus/EventBus.html
[Benchmarking]: https://github.com/MinecraftForge/EventBus/blob/master/Benchmarking.md
[YourKit Java Profiler]: https://www.yourkit.com/java/profiler/
4 changes: 2 additions & 2 deletions src/main/java/net/minecraftforge/eventbus/api/Event.java
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public boolean isCanceled() {
* invoke this method on an event that is not cancelable (as determined by {@link #isCancelable}
* will result in an {@link UnsupportedOperationException}.
* <br>
* The functionality of setting the canceled state is defined on a per-event bases.
* The functionality of setting the canceled state is defined on a per-event basis.
* <br>
* Throws a {@link IllegalStateException} if called during the {@link EventPriority#MINOTOR} phase.<br>
* Note: If the event bus does not track the phases then this protection doesn't function. Most standard
Expand Down Expand Up @@ -104,7 +104,7 @@ public Result getResult() {
* Sets the result value for this event, not all events can have a result set, and any attempt to
* set a result for a event that isn't expecting it will result in a IllegalArgumentException.
*
* The functionality of setting the result is defined on a per-event bases.
* The functionality of setting the result is defined on a per-event basis.
*
* @param value The new result
*/
Expand Down

0 comments on commit dc0fbc7

Please sign in to comment.