doc: add javadocs and package-info.java

Author: surajkumar

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);

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();
 

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;