From 62a2787298a00f079da34d637c091bc4a6ad332e Mon Sep 17 00:00:00 2001 From: Philipp Heuer Date: Tue, 30 Jun 2020 18:38:51 +0200 Subject: [PATCH] chore: add a few missing return javadoc comments --- chat/src/main/java/com/github/twitch4j/chat/TwitchChat.java | 3 ++- .../com/github/twitch4j/common/util/CollectionUtils.java | 1 + .../com/github/twitch4j/pubsub/domain/SubscriptionData.java | 6 ++++++ .../com/github/twitch4j/events/ChannelChangeGameEvent.java | 2 ++ .../com/github/twitch4j/events/ChannelChangeTitleEvent.java | 2 ++ 5 files changed, 13 insertions(+), 1 deletion(-) diff --git a/chat/src/main/java/com/github/twitch4j/chat/TwitchChat.java b/chat/src/main/java/com/github/twitch4j/chat/TwitchChat.java index b0529ca9f..9b3194701 100644 --- a/chat/src/main/java/com/github/twitch4j/chat/TwitchChat.java +++ b/chat/src/main/java/com/github/twitch4j/chat/TwitchChat.java @@ -146,7 +146,8 @@ public class TwitchChat implements AutoCloseable { * @param chatCredential Chat Credential * @param commandPrefixes Command Prefixes * @param chatQueueSize Chat Queue Size - * @param chatRateLimit Bandwidth / Bucket + * @param chatRateLimit Bandwidth / Bucket for chat + * @param whisperRateLimit Bandwidth / Buckets for whispers * @param taskExecutor ScheduledThreadPoolExecutor * @param chatQueueTimeout Timeout to wait for events in Chat Queue */ diff --git a/common/src/main/java/com/github/twitch4j/common/util/CollectionUtils.java b/common/src/main/java/com/github/twitch4j/common/util/CollectionUtils.java index 4ce5ade43..534f649db 100644 --- a/common/src/main/java/com/github/twitch4j/common/util/CollectionUtils.java +++ b/common/src/main/java/com/github/twitch4j/common/util/CollectionUtils.java @@ -9,6 +9,7 @@ public class CollectionUtils { /** * Assigns elements of the given iterable to chunks not exceeding the desired size * + * @param type of the iterable * @param iterable the source of elements to be assigned to a chunk * @param size the maximum size of each chunk * @return a list of the chunks, or an empty list if the iterable yielded no elements diff --git a/pubsub/src/main/java/com/github/twitch4j/pubsub/domain/SubscriptionData.java b/pubsub/src/main/java/com/github/twitch4j/pubsub/domain/SubscriptionData.java index 19a6e91f5..e6fbb31b4 100644 --- a/pubsub/src/main/java/com/github/twitch4j/pubsub/domain/SubscriptionData.java +++ b/pubsub/src/main/java/com/github/twitch4j/pubsub/domain/SubscriptionData.java @@ -89,6 +89,8 @@ public class SubscriptionData { /** * The id of the user that received the subscription + * + * @return the recipient id */ public String getRecipientId() { return this.recipientId != null ? this.recipientId : this.userId; @@ -96,6 +98,8 @@ public String getRecipientId() { /** * The login name of the user that received the subscription + * + * @return the recipient name */ public String getRecipientUserName() { return this.recipientUserName != null ? this.recipientUserName : this.userName; @@ -103,6 +107,8 @@ public String getRecipientUserName() { /** * The display name of the user that received the subscription + * + * @return the recipient display name */ public String getRecipientDisplayName() { return this.recipientDisplayName != null ? this.recipientDisplayName : this.displayName; diff --git a/twitch4j/src/main/java/com/github/twitch4j/events/ChannelChangeGameEvent.java b/twitch4j/src/main/java/com/github/twitch4j/events/ChannelChangeGameEvent.java index 9a473fdbf..cdbd194a5 100644 --- a/twitch4j/src/main/java/com/github/twitch4j/events/ChannelChangeGameEvent.java +++ b/twitch4j/src/main/java/com/github/twitch4j/events/ChannelChangeGameEvent.java @@ -25,6 +25,8 @@ public class ChannelChangeGameEvent extends TwitchEvent { /** * The new stream gameId + * + * @return id of the game */ public String getGameId() { return stream.getGameId(); diff --git a/twitch4j/src/main/java/com/github/twitch4j/events/ChannelChangeTitleEvent.java b/twitch4j/src/main/java/com/github/twitch4j/events/ChannelChangeTitleEvent.java index 70b609739..c3cda65c7 100644 --- a/twitch4j/src/main/java/com/github/twitch4j/events/ChannelChangeTitleEvent.java +++ b/twitch4j/src/main/java/com/github/twitch4j/events/ChannelChangeTitleEvent.java @@ -25,6 +25,8 @@ public class ChannelChangeTitleEvent extends TwitchEvent { /** * The new stream title + * + * @return current title for the stream */ public String getTitle() { return stream.getTitle();