chore: address sonar issues

Author: surajkumar

application/src/main/java/org/togetherjava/tjbot/Application.java

@@ -88,6 +88,7 @@ public static void main(final String[] args) {
      * Runs an instance of the bot, connecting to the given token and using the given database.
      *
      * @param config the configuration to run the bot with
+     * @param secrets the secrets to run the bot with
      */
     @SuppressWarnings("WeakerAccess")
     public static void runBot(Config config, Secrets secrets) {

application/src/main/java/org/togetherjava/tjbot/features/Features.java

@@ -105,6 +105,7 @@ private Features() {
      * @param jda the JDA instance commands will be registered at
      * @param database the database of the application, which features can use to persist data
      * @param config the configuration features should use
+     * @param secrets the secrets features may need
      * @return a collection of all features
      */
     public static Collection<Feature> createFeatures(JDA jda, Database database, Config config,

application/src/main/java/org/togetherjava/tjbot/features/filesharing/FileSharingMessageListener.java

@@ -56,7 +56,8 @@ public final class FileSharingMessageListener extends MessageReceiverAdapter
     /**
      * Creates a new instance.
      *
-     * @param config used to get api key and channel names.
+     * @param config used to get channel names.
+     * @param secrets used to get api key
      * @see org.togetherjava.tjbot.features.Features
      */
     public FileSharingMessageListener(Config config, Secrets secrets) {

application/src/main/java/org/togetherjava/tjbot/features/github/GitHubReference.java

@@ -82,6 +82,7 @@ public final class GitHubReference extends MessageReceiverAdapter {
      * a predicate for matching allowed channels for feature and acquires repositories.
      *
      * @param config The Config to get allowed channel pattern for feature.
+     * @param secrets The Secrets to get the GitHub API key.
      */
     public GitHubReference(Config config, Secrets secrets) {
         this.config = config;

application/src/main/java/org/togetherjava/tjbot/features/jshell/JShellEval.java

@@ -36,6 +36,7 @@ public class JShellEval {
      * Creates a JShell evaluation instance
      * 
      * @param config the JShell configuration to use
+     * @param baseUrl the base URL for the JSHell API
      * @param gistApiToken token of Gist api in case a JShell result is uploaded here
      */
     public JShellEval(JShellConfig config, String baseUrl, String gistApiToken) {

application/src/main/java/org/togetherjava/tjbot/features/system/BotCore.java

@@ -95,6 +95,7 @@ public final class BotCore extends ListenerAdapter implements CommandProvider {
      * @param jda the JDA instance that this command system will be used with
      * @param database the database that commands may use to persist data
      * @param config the configuration to use for this system
+     * @param secrets the secrets to use for this system
      */
     public BotCore(JDA jda, Database database, Config config, Secrets secrets) {
         this.config = config;

application/src/main/java/org/togetherjava/tjbot/secrets/Secrets.java

@@ -9,6 +9,9 @@
 import java.nio.file.Path;
 import java.util.Objects;
 
+/**
+ * This class contains secrets such as API keys, tokens etc., used by the application.
+ */
 public class Secrets {
     private final String token;
     private final String githubApiKey;
@@ -35,6 +38,13 @@ private Secrets(@JsonProperty(value = "token", required = true) String token,
         this.jshellBaseUrl = Objects.requireNonNull(jshellBaseUrl);
     }
 
+    /**
+     * Loads the configuration from the given file.
+     *
+     * @param path the location to secrets file
+     * @return the loaded configuration
+     * @throws IOException if the file could not be loaded
+     */
     public static Secrets load(Path path) throws IOException {
         return new ObjectMapper().registerModule(new JavaTimeModule())
             .readValue(path.toFile(), Secrets.class);

application/src/main/java/org/togetherjava/tjbot/secrets/package-info.java

@@ -0,0 +1,11 @@
+/**
+ * This package contains the secrets of the application. It revolves around the class
+ * {@link org.togetherjava.tjbot.secrets.Secrets}.
+ */
+@MethodsReturnNonnullByDefault
+@ParametersAreNonnullByDefault
+package org.togetherjava.tjbot.secrets;
+
+import org.togetherjava.tjbot.annotations.MethodsReturnNonnullByDefault;
+
+import javax.annotation.ParametersAreNonnullByDefault;