summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author zaaarf <zaaarf@proton.me>2023-08-23 23:22:02 +0200
committer zaaarf <zaaarf@proton.me>2023-08-23 23:22:02 +0200
commit4dcb9eca24583dd3df9ea644aa7f96c8e967d967 (patch)
tree76b56b3580a135cfc742b5c8a165a2aebb51dd15
parente24269a30b2bac3c7d553e3e3a204bb029bd2221 (diff)
chore: javadocs update
-rw-r--r--src/main/java/ftbsc/geb/api/IEvent.java2
-rw-r--r--src/main/java/ftbsc/geb/api/IEventCancelable.java5
2 files changed, 2 insertions, 5 deletions
diff --git a/src/main/java/ftbsc/geb/api/IEvent.java b/src/main/java/ftbsc/geb/api/IEvent.java
index 34c45db..6257430 100644
--- a/src/main/java/ftbsc/geb/api/IEvent.java
+++ b/src/main/java/ftbsc/geb/api/IEvent.java
@@ -2,7 +2,7 @@ package ftbsc.geb.api;
/**
* The common interface for all GEB events.
- * It doesn't do anything special, just provide a common superclass.
+ * It doesn't do anything special, it just provides a common superclass.
* @since 0.1.0
*/
public interface IEvent {}
diff --git a/src/main/java/ftbsc/geb/api/IEventCancelable.java b/src/main/java/ftbsc/geb/api/IEventCancelable.java
index c6630a1..73c9d75 100644
--- a/src/main/java/ftbsc/geb/api/IEventCancelable.java
+++ b/src/main/java/ftbsc/geb/api/IEventCancelable.java
@@ -6,8 +6,7 @@ package ftbsc.geb.api;
*/
public interface IEventCancelable extends IEvent {
/**
- * Checks whether the event was canceled; any user-defined
- * implementation will be ignored.
+ * Checks whether the event was canceled.
* @return whether the event was canceled
*/
default boolean isCanceled() {
@@ -16,7 +15,6 @@ public interface IEventCancelable extends IEvent {
/**
* Cancels the event.
- * Any user-defined implementation will be ignored.
*/
default void setCanceled() {
this.setCanceled(true);
@@ -24,7 +22,6 @@ public interface IEventCancelable extends IEvent {
/**
* Cancels the event.
- * Any user-defined implementation will be ignored.
* @param canceled whether the event should be set to canceled
*/
default void setCanceled(boolean canceled) {}