From 6dfc798cef8dd2c43fbaa26ede1e419ad287a4da Mon Sep 17 00:00:00 2001 From: Suraj Kumar Date: Fri, 23 Jan 2026 19:51:00 +0000 Subject: [PATCH] doc: add javadocs and package-info.java --- .../tjbot/config/DynamicVoiceChatConfig.java | 4 ++++ .../tjbot/features/voicechat/DynamicVoiceChat.java | 6 ++++++ .../tjbot/features/voicechat/package-info.java | 10 ++++++++++ 3 files changed, 20 insertions(+) create mode 100644 application/src/main/java/org/togetherjava/tjbot/features/voicechat/package-info.java diff --git a/application/src/main/java/org/togetherjava/tjbot/config/DynamicVoiceChatConfig.java b/application/src/main/java/org/togetherjava/tjbot/config/DynamicVoiceChatConfig.java index bac0a14318..6215da5636 100644 --- a/application/src/main/java/org/togetherjava/tjbot/config/DynamicVoiceChatConfig.java +++ b/application/src/main/java/org/togetherjava/tjbot/config/DynamicVoiceChatConfig.java @@ -23,6 +23,10 @@ public record DynamicVoiceChatConfig( @JsonProperty(value = "cleanChannelsAmount") int cleanChannelsAmount, @JsonProperty(value = "minimumChannelsAmount", required = true) int minimumChannelsAmount) { + /** + * Constructs an instance of {@code DynamicVoiceChatConfig} and throws if + * {@code dynamicChannelPatterns} or @{code archiveCategoryPattern} is null. + */ public DynamicVoiceChatConfig { Objects.requireNonNull(dynamicChannelPatterns); Objects.requireNonNull(archiveCategoryPattern); diff --git a/application/src/main/java/org/togetherjava/tjbot/features/voicechat/DynamicVoiceChat.java b/application/src/main/java/org/togetherjava/tjbot/features/voicechat/DynamicVoiceChat.java index 8fbb4c3751..28c25430bc 100644 --- a/application/src/main/java/org/togetherjava/tjbot/features/voicechat/DynamicVoiceChat.java +++ b/application/src/main/java/org/togetherjava/tjbot/features/voicechat/DynamicVoiceChat.java @@ -35,6 +35,12 @@ public final class DynamicVoiceChat extends VoiceReceiverAdapter { private final VoiceChatCleanupStrategy voiceChatCleanupStrategy; private final DynamicVoiceChatConfig dynamicVoiceChannelConfig; + /** + * Creates a new instance of {@code DynamicVoiceChat} + * + * @param config the configurations needed for this feature. See: + * {@link org.togetherjava.tjbot.config.DynamicVoiceChatConfig} + */ public DynamicVoiceChat(Config config) { this.dynamicVoiceChannelConfig = config.getDynamicVoiceChatConfig(); diff --git a/application/src/main/java/org/togetherjava/tjbot/features/voicechat/package-info.java b/application/src/main/java/org/togetherjava/tjbot/features/voicechat/package-info.java new file mode 100644 index 0000000000..57ab07e37c --- /dev/null +++ b/application/src/main/java/org/togetherjava/tjbot/features/voicechat/package-info.java @@ -0,0 +1,10 @@ +/** + * This package contains classes for the dynamic voice chat functionality. + */ +@MethodsReturnNonnullByDefault +@ParametersAreNonnullByDefault +package org.togetherjava.tjbot.features.voicechat; + +import org.togetherjava.tjbot.annotations.MethodsReturnNonnullByDefault; + +import javax.annotation.ParametersAreNonnullByDefault;