mirror of
https://github.com/BlueMap-Minecraft/BlueMapAPI.git
synced 2024-10-31 15:49:54 +01:00
Fix javadoc errors
This commit is contained in:
parent
ad77b492dd
commit
c70ab29ae8
@ -40,15 +40,14 @@ public interface AssetStorage {
|
||||
/**
|
||||
* 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
|
||||
* gets closed!
|
||||
* <p>
|
||||
* gets closed!<br>
|
||||
* <br>
|
||||
* Example:
|
||||
* <pre>
|
||||
* try (OutputStream out = assetStorage.writeAsset("image.png")) {
|
||||
* ImageIO.write(image, "png", out);
|
||||
* }
|
||||
* </pre>
|
||||
* </p>
|
||||
* @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.<br>
|
||||
* Use the returned {@link InputStream} to read the asset-data.
|
||||
* <p>
|
||||
* Use the returned {@link InputStream} to read the asset-data.<br>
|
||||
* <br>
|
||||
* Example:
|
||||
* <pre>
|
||||
* Optional<InputStream> optIn = assetStorage.readAsset("image.png");
|
||||
@ -68,7 +67,6 @@ public interface AssetStorage {
|
||||
* }
|
||||
* }
|
||||
* </pre>
|
||||
* </p>
|
||||
* @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.
|
||||
|
@ -61,15 +61,14 @@ public interface WebApp {
|
||||
* 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>
|
||||
* 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!
|
||||
* <p>
|
||||
* Style-registrations are <b>not persistent</b>, register your style each time bluemap enables!<br>
|
||||
* <br>
|
||||
* Example:
|
||||
* <pre>
|
||||
* BlueMapAPI.onEnable(api -> {
|
||||
* api.getWebApp().registerStyle("js/my-custom-style.css");
|
||||
* });
|
||||
* </pre>
|
||||
* </p>
|
||||
* @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 <i>(before bluemap loaded,
|
||||
* pre server-start!)</i> to {@link BlueMapAPI#onEnable(Consumer)}.<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!
|
||||
* <p>
|
||||
* Script-registrations are <b>not persistent</b>, register your script each time bluemap enables!<br>
|
||||
* <br>
|
||||
* Example:
|
||||
* <pre>
|
||||
* BlueMapAPI.onEnable(api -> {
|
||||
* api.getWebApp().registerScript("js/my-custom-script.js");
|
||||
* });
|
||||
* </pre>
|
||||
* </p>
|
||||
* @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.
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user