chore: javadocs update

This commit is contained in:
zaaarf 2023-08-23 23:22:02 +02:00
parent e24269a30b
commit 4dcb9eca24
No known key found for this signature in database
GPG key ID: 6445A5CD15E5B40C
2 changed files with 2 additions and 5 deletions

View file

@ -2,7 +2,7 @@ package ftbsc.geb.api;
/** /**
* The common interface for all GEB events. * 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 * @since 0.1.0
*/ */
public interface IEvent {} public interface IEvent {}

View file

@ -6,8 +6,7 @@ package ftbsc.geb.api;
*/ */
public interface IEventCancelable extends IEvent { public interface IEventCancelable extends IEvent {
/** /**
* Checks whether the event was canceled; any user-defined * Checks whether the event was canceled.
* implementation will be ignored.
* @return whether the event was canceled * @return whether the event was canceled
*/ */
default boolean isCanceled() { default boolean isCanceled() {
@ -16,7 +15,6 @@ public interface IEventCancelable extends IEvent {
/** /**
* Cancels the event. * Cancels the event.
* Any user-defined implementation will be ignored.
*/ */
default void setCanceled() { default void setCanceled() {
this.setCanceled(true); this.setCanceled(true);
@ -24,7 +22,6 @@ public interface IEventCancelable extends IEvent {
/** /**
* Cancels the event. * Cancels the event.
* Any user-defined implementation will be ignored.
* @param canceled whether the event should be set to canceled * @param canceled whether the event should be set to canceled
*/ */
default void setCanceled(boolean canceled) {} default void setCanceled(boolean canceled) {}