Fix javadoc generation

Author: JulianVennen

src/main/java/com/exaroton/api/APIRequest.java

@@ -13,6 +13,7 @@
 public abstract class APIRequest<Response> {
     /**
      * Build the HttpRequest
+     * @param gson gson instance
      * @param builder HttpRequest builder with preconfigured options
      * @param baseUrl base URL
      * @return HttpRequest

src/main/java/com/exaroton/api/APIResponse.java

@@ -2,11 +2,13 @@
 
 import com.google.gson.Gson;
 import com.google.gson.reflect.TypeToken;
+import org.jetbrains.annotations.NotNull;
 
 import java.net.http.HttpResponse;
 import java.nio.ByteBuffer;
 import java.nio.charset.StandardCharsets;
 import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionException;
 import java.util.concurrent.CompletionStage;
@@ -31,12 +33,18 @@ public class APIResponse<Datatype> {
 
     /**
      * Create a BodyHandler for APIResponse
-     * @param gson gson instance
-     * @param token type token of the response data
+     *
+     * @param client exaroton client
+     * @param gson   gson instance
+     * @param token  type token of the response data
+     * @param <T>    response data type
      * @return BodyHandler
-     * @param <T> response data type
      */
-    public static <T> HttpResponse.BodyHandler<APIResponse<T>> bodyHandler(ExarotonClient client, Gson gson, TypeToken<APIResponse<T>> token) {
+    public static <T> HttpResponse.BodyHandler<APIResponse<T>> bodyHandler(
+            @NotNull ExarotonClient client,
+            @NotNull Gson gson,
+            @NotNull TypeToken<APIResponse<T>> token
+    ) {
         return responseInfo -> new BodySubscriber<>(client, gson, token);
     }
 
@@ -81,10 +89,14 @@ private static final class BodySubscriber<T> implements HttpResponse.BodySubscri
         private final TypeToken<APIResponse<T>> token;
         private final HttpResponse.BodySubscriber<String> parent;
 
-        private BodySubscriber(ExarotonClient client, Gson gson, TypeToken<APIResponse<T>> token) {
-            this.client = client;
-            this.gson = gson;
-            this.token = token;
+        private BodySubscriber(
+                @NotNull ExarotonClient client,
+                @NotNull Gson gson,
+                @NotNull TypeToken<APIResponse<T>> token
+        ) {
+            this.client = Objects.requireNonNull(client);
+            this.gson = Objects.requireNonNull(gson);
+            this.token = Objects.requireNonNull(token);
             this.parent = HttpResponse.BodySubscribers.ofString(StandardCharsets.UTF_8);
         }
 

src/main/java/com/exaroton/api/Initializable.java

@@ -2,6 +2,7 @@
 
 import com.google.gson.Gson;
 import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * Interface for objects that can be initialized
@@ -14,5 +15,5 @@ public interface Initializable {
      * @param client exaroton client
      * @param gson   gson instance
      */
-    void initialize(ExarotonClient client, Gson gson);
+    void initialize(@NotNull ExarotonClient client, @NotNull Gson gson);
 }

src/main/java/com/exaroton/api/ParameterValidator.java

@@ -94,7 +94,7 @@ public static <M extends Map<K, V>, K, V> M requireNonEmpty(M map, String name)
     }
 
     /**
-     * Require that a number is not null and positive (> 0)
+     * Require that a number is not null and positive (&gt; 0)
      *
      * @param number number to validate
      * @param name   name of the parameter

src/main/java/com/exaroton/api/billing/pools/CreditPool.java

@@ -170,12 +170,11 @@ public double getOwnCredits() {
      * Set the exaroton client used for further requests
      *
      * @param client exaroton client
-     * @return updated pool object
      */
     @ApiStatus.Internal
     @Override
-    public void initialize(ExarotonClient client, Gson gson) {
-        this.client = client;
+    public void initialize(@NotNull ExarotonClient client, @NotNull Gson gson) {
+        this.client = Objects.requireNonNull(client);
         this.fetched = true;
     }
 

src/main/java/com/exaroton/api/server/PlayerList.java

@@ -63,6 +63,7 @@ public CompletableFuture<List<String>> getEntries() throws IOException {
      * add players to list
      *
      * @param entries player names
+     * @return completable future with all players in the list
      * @throws IOException Connection errors
      */
     public CompletableFuture<List<String>> add(List<String> entries) throws IOException {
@@ -77,6 +78,7 @@ public CompletableFuture<List<String>> add(List<String> entries) throws IOExcept
      * remove players from list
      *
      * @param entries player names
+     * @return completable future with all players in the list
      * @throws IOException Connection errors
      */
     public CompletableFuture<List<String>> remove(List<String> entries) throws IOException {

src/main/java/com/exaroton/api/server/Server.java

@@ -373,6 +373,7 @@ public CompletableFuture<Server> restart() throws IOException {
      * Execute a server command. If a websocket connection with the console stream is active the command will be sent via the websocket.
      *
      * @param command command that will be sent to the console
+     * @return completable future that completes once the command has been sent
      * @throws IOException connection errors
      */
     public CompletableFuture<Void> executeCommand(String command) throws IOException {

src/main/java/com/exaroton/api/server/ServerFile.java

@@ -152,7 +152,7 @@ public CompletableFuture<Void> putContent(String content) throws IOException {
      * @see #upload(InputStream)
      * @see #upload(Supplier)
      */
-    public CompletableFuture<Void> upload(Path path) throws IOException, APIException {
+    public CompletableFuture<Void> upload(Path path) throws IOException {
         return upload(Files.newInputStream(path));
     }
 

src/main/java/com/exaroton/api/server/config/options/BaseSelectOption.java

@@ -8,7 +8,7 @@
 
 /**
  * Base class for select and multi-select options
- * @param <T> value type (String or Set<String>)
+ * @param <T> value type (String or Set&lt;String&gt;)
  */
 @ApiStatus.NonExtendable
 public class BaseSelectOption<T> extends ConfigOption<T> {

src/main/java/com/exaroton/api/ws/WebSocketClient.java

@@ -20,6 +20,7 @@ public final class WebSocketClient extends org.java_websocket.client.WebSocketCl
     private final WebSocketManager manager;
 
     /**
+     * @param logger SLF4J logger
      * @param uri websocket uri
      * @param manager websocket manager
      */