Javadoc stuff

Author: java-coding-prodigy

application/src/main/java/org/togetherjava/tjbot/config/Config.java

@@ -356,8 +356,9 @@ public JShellConfig getJshell() {
     }
 
     /**
-     * Gets the config for the Starboard Contains the List of emoji names recognized by the
-     * starboard as well as the name of the channel with the starboard.
+     * Gets the config for the Starboard. The starboard displays certain messages in a special
+     * channel {@link StarboardConfig#channelName()} if a user reacts with one of the recognized
+     * emojis{@link StarboardConfig#emojiNames()}
      * 
      * @return the config of the Starboard
      */

application/src/main/java/org/togetherjava/tjbot/config/StarboardConfig.java

@@ -1,25 +1,35 @@
 package org.togetherjava.tjbot.config;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
-import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonRootName;
 
 import java.util.List;
 import java.util.Objects;
 
+/**
+ * Starboard Config
+ *
+ * @param emojiNames the List of emojis which are recognized by the starboard
+ * @param channelName the name of the channel with the starboard
+ */
 @JsonRootName("starboard")
 public record StarboardConfig(List<String> emojiNames, String channelName) {
+    /**
+     * Creates a Starboard config.
+     *
+     * @param emojiNames the List of emojis which are recognized by the starboard
+     * @param channelName the name of the channel with the starboard
+     */
     @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
-    public StarboardConfig(
-            @JsonProperty(value = "emojiNames", required = true) List<String> emojiNames,
-            @JsonProperty(value = "channelName", required = true) String channelName) {
-        this.emojiNames = Objects.requireNonNull(emojiNames);
-        this.channelName = Objects.requireNonNull(channelName);
+    public StarboardConfig {
+        Objects.requireNonNull(emojiNames);
+        Objects.requireNonNull(channelName);
     }
 
     /**
      * Gets the list of emotes that are recognized by the starboard feature. A message that is
-     * reacted on with an emote in this list will be reposted in a special channel.
+     * reacted on with an emote in this list will be reposted in a special channel
+     * {@link #channelName()}.
      * <p>
      * Empty to deactivate the feature.
      *
@@ -31,8 +41,8 @@ public List<String> emojiNames() {
     }
 
     /**
-     * Gets the name of the channel with the starboard Deactivate by using a non-existent channel
-     * name
+     * Gets the name of the channel with the starboard. Deactivate by using a non-existent channel
+     * name.
      *
      * @return the name of the channel with the starboard
      */