Add two little javadocs

KittehOrg · Feb 3, 2019 · f8a2c75 · f8a2c75
1 parent 7bb8c90
commit f8a2c75
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/src/main/java/org/kitteh/irc/client/library/event/abstractbase/ClientBatchEventBase.java b/src/main/java/org/kitteh/irc/client/library/event/abstractbase/ClientBatchEventBase.java
@@ -31,6 +31,11 @@
 
 import java.util.List;
 
+/**
+ * Abstract base class for batch related events.
+ *
+ * @see BatchEvent
+ */
 public class ClientBatchEventBase extends ServerMessageEventBase implements BatchEvent {
     private final BatchReferenceTag tag;
 

diff --git a/src/main/java/org/kitteh/irc/client/library/event/helper/BatchEvent.java b/src/main/java/org/kitteh/irc/client/library/event/helper/BatchEvent.java
@@ -30,5 +30,10 @@
  * An event involving batched messages.
  */
 public interface BatchEvent extends ServerMessageEvent {
+    /**
+     * Gets the reference tag.
+     *
+     * @return reference tag
+     */
     @NonNull BatchReferenceTag getReferenceTag();
 }