From 35aa316199552870f5087102f9f2617c3b11f85f Mon Sep 17 00:00:00 2001 From: delvh Date: Wed, 25 Mar 2020 17:12:55 +0100 Subject: [PATCH] Fixed Javadoc in GroupResizeEvent --- src/main/java/envoy/event/GroupResizeEvent.java | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/src/main/java/envoy/event/GroupResizeEvent.java b/src/main/java/envoy/event/GroupResizeEvent.java index 1b6d153..e898752 100644 --- a/src/main/java/envoy/event/GroupResizeEvent.java +++ b/src/main/java/envoy/event/GroupResizeEvent.java @@ -5,6 +5,10 @@ import envoy.data.Group; import envoy.data.User; /** + * This event is used to communicate changes in the group size between client + * and server.
+ * Possible actions are adding or removing certain {@link User}s to or from a certain {@link Group} + *
* Project: envoy-common
* File: GroupResizeEvent.java
* Created: 25 Mar 2020
@@ -20,6 +24,10 @@ public class GroupResizeEvent extends Event { private static final long serialVersionUID = 0L; /** + * This enum defines all possibilities for handling + * {@link GroupResizeEvent}s.
+ * These can be: {@link OperationType#ADD} or {@link OperationType#REMOVE}.
+ *
* Project: envoy-common
* File: GroupResizeEvent.java
* Created: 25 Mar 2020
@@ -29,11 +37,13 @@ public class GroupResizeEvent extends Event { */ public enum OperationType { /** - * + * Select this element, if the given {@link User} should be added to the given + * {@link Group} */ ADD, /** - * + * Select this element, if the given {@link User} should be removed from the + * given {@link Group} */ REMOVE }