Upstream/BlueMapAPI
1
0
Fork 0
mirror of https://github.com/BlueMap-Minecraft/BlueMapAPI.git synced 2024-10-31 23:59:42 +01:00
Code Issues Projects Releases Wiki Activity

Fix javadoc errors

Browse Source
This commit is contained in:
Lukas Rieger (Blue) 2023-01-02 22:42:50 +01:00
parent ad77b492dd
commit c70ab29ae8
No known key found for this signature in database
GPG Key ID: 2D09EC5ED2687FF2
2 changed files with 8 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/main/java/de/bluecolored/bluemap/api/AssetStorage.java
View File

@ -40,15 +40,14 @@ public interface AssetStorage {
/** /**
* Writes a new asset into this storage, overwriting any existent assets with the same name.<br> * Writes a new asset into this storage, overwriting any existent assets with the same name.<br>
* Use the returned {@link OutputStream} to write the asset-data. The asset will be added to the storage as soon as that stream * 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!<br>
* <p> * <br>
* Example: * Example:
* <pre> * <pre>
* try (OutputStream out = assetStorage.writeAsset("image.png")) { * try (OutputStream out = assetStorage.writeAsset("image.png")) {
* ImageIO.write(image, "png", out); * ImageIO.write(image, "png", out);
* } * }
* </pre> * </pre>
* </p>
* @param name The (unique) name for this asset * @param name The (unique) name for this asset
* @return An {@link OutputStream} that should be used to write the asset and closed once! * @return An {@link OutputStream} that should be used to write the asset and closed once!
* @throws IOException when the underlying storage rises an IOException * @throws IOException when the underlying storage rises an IOException
@ -57,8 +56,8 @@ public interface AssetStorage {
/** /**
* Reads an asset from this storage.<br> * Reads an asset from this storage.<br>
* Use the returned {@link InputStream} to read the asset-data. * Use the returned {@link InputStream} to read the asset-data.<br>
* <p> * <br>
* Example: * Example:
* <pre> * <pre>
* Optional&lt;InputStream&gt; optIn = assetStorage.readAsset("image.png"); * Optional&lt;InputStream&gt; optIn = assetStorage.readAsset("image.png");
@ -68,7 +67,6 @@ public interface AssetStorage {
* } * }
* } * }
* </pre> * </pre>
* </p>
* @param name The name of the asset that should be read from the storage. * @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. * @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. * Or an empty optional if there is no asset with this name.

10
src/main/java/de/bluecolored/bluemap/api/WebApp.java
View File

@ -61,15 +61,14 @@ public interface WebApp {
* This method should only be used inside the {@link Consumer} that got registered <i>(before bluemap loaded, * This method should only be used inside the {@link Consumer} that got registered <i>(before bluemap loaded,
* pre server-start!)</i> to {@link BlueMapAPI#onEnable(Consumer)}.<br> * pre server-start!)</i> to {@link BlueMapAPI#onEnable(Consumer)}.<br>
* Invoking this method at any other time is not supported.<br> * Invoking this method at any other time is not supported.<br>
* Style-registrations are <b>not persistent</b>, register your style each time bluemap enables! * Style-registrations are <b>not persistent</b>, register your style each time bluemap enables!<br>
* <p> * <br>
* Example: * Example:
* <pre> * <pre>
* BlueMapAPI.onEnable(api -> { * BlueMapAPI.onEnable(api -> {
* api.getWebApp().registerStyle("js/my-custom-style.css"); * api.getWebApp().registerStyle("js/my-custom-style.css");
* }); * });
* </pre> * </pre>
* </p>
* @param url The (relative) URL that links to the style.css file. The {@link #getWebRoot()}-method can be used to * @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. * 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 <i>(before bluemap loaded, * This method should only be used inside the {@link Consumer} that got registered <i>(before bluemap loaded,
* pre server-start!)</i> to {@link BlueMapAPI#onEnable(Consumer)}.<br> * pre server-start!)</i> to {@link BlueMapAPI#onEnable(Consumer)}.<br>
* Invoking this method at any other time is not supported.<br> * Invoking this method at any other time is not supported.<br>
* Script-registrations are <b>not persistent</b>, register your script each time bluemap enables! * Script-registrations are <b>not persistent</b>, register your script each time bluemap enables!<br>
* <p> * <br>
* Example: * Example:
* <pre> * <pre>
* BlueMapAPI.onEnable(api -> { * BlueMapAPI.onEnable(api -> {
* api.getWebApp().registerScript("js/my-custom-script.js"); * api.getWebApp().registerScript("js/my-custom-script.js");
* }); * });
* </pre> * </pre>
* </p>
* @param url The (relative) URL that links to the script.js file. The {@link #getWebRoot()}-method can be used to * @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. * create the custom file in the correct location and make it available to the web-app.
*/ */