zaaarf/geb
1
0
Fork 0
mirror of https://github.com/zaaarf/geb.git synced 2024-11-25 11:14:48 +01:00
Code Issues Projects Releases Packages Wiki Activity

chore: javadocs update

Browse source
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
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/main/java/ftbsc/geb/api/IEvent.java
View file

@ -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 {}

5
src/main/java/ftbsc/geb/api/IEventCancelable.java
View file

@ -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) {}