Fix some incorrect javadoc

Author: TBlueF

.gitignore

@@ -14,6 +14,10 @@ bin/
 bin/*
 */bin/*
 
+doc/
+doc/*
+*/doc/*
+
 .classpath
 */.classpath
 

src/main/java/de/bluecolored/bluemap/api/BlueMapAPI.java

@@ -55,6 +55,7 @@ public abstract class BlueMapAPI {
 	 * Getter for the {@link MarkerAPI}.<br>
 	 * Calling this gives you a fresh loaded {@link MarkerAPI}, so you don't have to call {@link MarkerAPI#load()} right away!
 	 * @return the {@link MarkerAPI}
+	 * @throws IOException if there was an IOException loading the marker.json
 	 */
 	public abstract MarkerAPI getMarkerAPI() throws IOException;
 
@@ -138,7 +139,9 @@ public static synchronized Optional<BlueMapAPI> getInstance() {
 
 	/**
 	 * Used by BlueMap to register the API and call the listeners properly. 
-	 * @param instance {@link BlueMapAPI}-instance
+	 * @param instance the {@link BlueMapAPI}-instance
+	 * @return <code>true</code> if the instance has been registered, <code>false</code> if there already was an instance registered 
+	 * @throws ExecutionException if a {@link BlueMapAPIListener} threw an exception during the registration
 	 */
 	protected static synchronized boolean registerInstance(BlueMapAPI instance) throws ExecutionException {
 		if (BlueMapAPI.instance != null) return false;
@@ -167,6 +170,9 @@ protected static synchronized boolean registerInstance(BlueMapAPI instance) thro
 
 	/**
 	 * Used by BlueMap to unregister the API and call the listeners properly.
+	 * @param instance the {@link BlueMapAPI} instance
+	 * @return <code>true</code> if the instance was unregistered, <code>false</code> if there was no or an other instance registered
+	 * @throws ExecutionException if a {@link BlueMapAPIListener} threw an exception during the un-registration
 	 */
 	protected static synchronized boolean unregisterInstance(BlueMapAPI instance) throws ExecutionException {
 		if (BlueMapAPI.instance != instance) return false;

src/main/java/de/bluecolored/bluemap/api/BlueMapAPIListener.java

@@ -29,16 +29,16 @@ public interface BlueMapAPIListener {
 	/**
 	 * Called when BlueMap has been loaded and started and the API is ready to use.<br>
 	 * If {@link BlueMapAPI} is already enabled when this listener is registered this method will be called immediately <i>(on the same thread)</i>!
-	 * <p><i>(Note: This method will likely be called asynchronously, <b>not</b> on the server-thread!</i><p>
+	 * <p><i>(Note: This method will likely be called asynchronously, <b>not</b> on the server-thread!</i></p>
 	 * @param blueMapApi the {@link BlueMapAPI}
 	 */
 	default void onEnable(BlueMapAPI blueMapApi) {}
 
 	/**
 	 * Called <b>before</b> BlueMap is being unloaded and stopped, after this method returns the API is no longer usable!<br>
 	 * Unlike {@link BlueMapAPIListener#onEnable(BlueMapAPI)}, if {@link BlueMapAPI} is not enabled when this listener is registered this method will <b>not</b> be called immediately.
-	 * <p><i>(Note: This method will likely be called asynchronously, <b>not</b> on the server-thread!</i><p>
-	 * @param blueMapApi
+	 * <p><i>(Note: This method will likely be called asynchronously, <b>not</b> on the server-thread!</i></p>
+	 * @param blueMapApi the {@link BlueMapAPI}
 	 */
 	default void onDisable(BlueMapAPI blueMapApi) {}
 

src/main/java/de/bluecolored/bluemap/api/BlueMapMap.java

@@ -67,6 +67,10 @@ public interface BlueMapMap {
 
 	/**
 	 * Converts a block-position to a map-tile-coordinate for this map
+	 * 
+	 * @param blockX the x-position of the block
+	 * @param blockZ the z-position of the block
+	 * @return the tile position
 	 */
 	default Vector2i posToTile(double blockX, double blockZ){
 		Vector2i offset = getTileOffset();
@@ -80,13 +84,19 @@ default Vector2i posToTile(double blockX, double blockZ){
 
 	/**
 	 * Converts a block-position to a map-tile-coordinate for this map
+	 * 
+	 * @param pos the position of the block
+	 * @return the tile position
 	 */
 	default Vector2i posToTile(Vector3i pos){
 		return posToTile(pos.getX(), pos.getZ());
 	}
 
 	/**
 	 * Converts a block-position to a map-tile-coordinate for this map
+	 * 
+	 * @param pos the position of the block
+	 * @return the tile position
 	 */
 	default Vector2i posToTile(Vector3d pos){
 		return posToTile(pos.getX(), pos.getZ()); 

src/main/java/de/bluecolored/bluemap/api/BlueMapWorld.java

@@ -41,13 +41,14 @@ public interface BlueMapWorld {
 	 * <p>
 	 * 	<b>Implementation notes:</b><br>
 	 * 	The used UUID highly depends on the implementation
+	 * </p>
 	 * 	<table>
-	 *  	<tr><th>Sponge</th><td>The UUID is equal to the returned UUID by world-instances of the Sponge-API, so you can just use <code>spongeWorld.getUniqueId()</code><td><tr>
-	 *  	<tr><th>Bukkit</th><td>The UUID is equal to the returned UUID by world-instances of the Bukkit-API, so you can just use <code>bukkitWorld.getUID()</code><td><tr>
-	 *  	<tr><th>Forge</th><td>The UUID is randomly generated, and changes on each reload/restart</code><td><tr>
-	 *  	<tr><th>CLI</th><td>The UUID is randomly generated, and changes on each reload/restart</code><td><tr>
+	 * 		<caption>Implementations</caption>
+	 *  	<tr><th>Sponge</th><td>The UUID is equal to the returned UUID by world-instances of the Sponge-API, so you can just use <code>spongeWorld.getUniqueId()</code></td></tr>
+	 *  	<tr><th>Bukkit</th><td>The UUID is equal to the returned UUID by world-instances of the Bukkit-API, so you can just use <code>bukkitWorld.getUID()</code></td></tr>
+	 *  	<tr><th>Forge</th><td>The UUID is randomly generated, and changes on each reload/restart</td></tr>
+	 *  	<tr><th>CLI</th><td>The UUID is randomly generated, and changes on each reload/restart</td></tr>
 	 *  </table>
-	 * </p>
 	 * 
 	 * @return the {@link UUID} of the world
 	 */

src/main/java/de/bluecolored/bluemap/api/marker/ShapeMarker.java

@@ -75,8 +75,8 @@ public interface ShapeMarker extends Marker {
 
 	/**
 	 * Sets the border- and fill- color. 
-	 * @param borderColor
-	 * @param fillColor
+	 * @param borderColor the new border-color
+	 * @param fillColor the new fill-color
 	 * @see #setBorderColor(Color)
 	 * @see #setFillColor(Color)
 	 */

src/main/java/de/bluecolored/bluemap/api/renderer/RenderAPI.java

@@ -68,8 +68,6 @@ default void render(BlueMapWorld world, Vector3i blockPosition) {
 	 * @param mapId the id of the {@link BlueMapMap} to render
 	 * @param blockPosition a {@link Vector3i} for the block-position to render (the whole map-tile will be rendered not only that block)
 	 * 
-	 * @return the scheduled {@link RenderTicket}
-	 * 
 	 * @throws IllegalArgumentException if there is no map loaded with the provided mapId
 	 */
 	void render(String mapId, Vector3i blockPosition);