From c70ab29ae87cd79a3553bef4aca7fa94db577293 Mon Sep 17 00:00:00 2001 From: "Lukas Rieger (Blue)" Date: Mon, 2 Jan 2023 22:42:50 +0100 Subject: [PATCH] Fix javadoc errors --- .../java/de/bluecolored/bluemap/api/AssetStorage.java | 10 ++++------ src/main/java/de/bluecolored/bluemap/api/WebApp.java | 10 ++++------ 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/src/main/java/de/bluecolored/bluemap/api/AssetStorage.java b/src/main/java/de/bluecolored/bluemap/api/AssetStorage.java index 4df1a23..a5ba4a4 100644 --- a/src/main/java/de/bluecolored/bluemap/api/AssetStorage.java +++ b/src/main/java/de/bluecolored/bluemap/api/AssetStorage.java @@ -40,15 +40,14 @@ public interface AssetStorage { /** * Writes a new asset into this storage, overwriting any existent assets with the same name.
* Use the returned {@link OutputStream} to write the asset-data. The asset will be added to the storage as soon as that stream - * gets closed! - *

+ * gets closed!
+ *
* Example: * 

      * try (OutputStream out = assetStorage.writeAsset("image.png")) {
      *     ImageIO.write(image, "png", out);
      * }
      *
- *

* @param name The (unique) name for this asset * @return An {@link OutputStream} that should be used to write the asset and closed once! * @throws IOException when the underlying storage rises an IOException @@ -57,8 +56,8 @@ public interface AssetStorage { /** * Reads an asset from this storage.
- * Use the returned {@link InputStream} to read the asset-data. - *

+ * Use the returned {@link InputStream} to read the asset-data.
+ *
* Example: * 

      * Optional<InputStream> optIn = assetStorage.readAsset("image.png");
@@ -68,7 +67,6 @@ public interface AssetStorage {
      *     }
      * }
      *
- *

* @param name The name of the asset that should be read from the storage. * @return An {@link Optional} with an {@link InputStream} when the asset is found, from which the asset can be read. * Or an empty optional if there is no asset with this name. diff --git a/src/main/java/de/bluecolored/bluemap/api/WebApp.java b/src/main/java/de/bluecolored/bluemap/api/WebApp.java index 38ee015..7088b6c 100644 --- a/src/main/java/de/bluecolored/bluemap/api/WebApp.java +++ b/src/main/java/de/bluecolored/bluemap/api/WebApp.java @@ -61,15 +61,14 @@ public interface WebApp { * This method should only be used inside the {@link Consumer} that got registered (before bluemap loaded, * pre server-start!) to {@link BlueMapAPI#onEnable(Consumer)}.
* Invoking this method at any other time is not supported.
- * Style-registrations are not persistent, register your style each time bluemap enables! - *

+ * Style-registrations are not persistent, register your style each time bluemap enables!
+ *
* Example: * 

      * BlueMapAPI.onEnable(api -> {
      *    api.getWebApp().registerStyle("js/my-custom-style.css");
      * });
      *
- *

* @param url The (relative) URL that links to the style.css file. The {@link #getWebRoot()}-method can be used to * create the custom file in the correct location and make it available to the web-app. */ @@ -80,15 +79,14 @@ public interface WebApp { * This method should only be used inside the {@link Consumer} that got registered (before bluemap loaded, * pre server-start!) to {@link BlueMapAPI#onEnable(Consumer)}.
* Invoking this method at any other time is not supported.
- * Script-registrations are not persistent, register your script each time bluemap enables! - *

+ * Script-registrations are not persistent, register your script each time bluemap enables!
+ *
* Example: * 

      * BlueMapAPI.onEnable(api -> {
      *    api.getWebApp().registerScript("js/my-custom-script.js");
      * });
      *
- *

* @param url The (relative) URL that links to the script.js file. The {@link #getWebRoot()}-method can be used to * create the custom file in the correct location and make it available to the web-app. */