Javadoc issues

2015-09-26 23:31:17 +02:00
parent 3a30ca7570
commit dca09fe0a6
2 changed files with 135 additions and 4 deletions
@@ -29,9 +29,9 @@ import net.minecraft.world.World;
 /**
 * An interface similar to {@link Callable}, but allowing to pass the {@link World} when calling.
 *
- * @see Callable
 * @author yueh
 * @version rv3
+ * @see Callable
 * @since rv3
 */
 public interface IWorldCallable<T>
@@ -39,10 +39,13 @@ public interface IWorldCallable<T>
 	/**
 	 * Similar to {@link Callable#call()}
 	 *
+	 * @param world this param is given to not hold a reference to the world but let the caller handle it. Do not expect a world here thus can be
+	 * <tt>null</tt>.
+	 *
+	 * @return result of call on the world. Can be <tt>null</tt>.
+	 *
+	 * @throws Exception if the call fails
 	 * @see Callable#call()
-	 * @param world
-	 * @return
-	 * @throws Exception
 	 */
 	@Nullable
 	T call( @Nullable World world ) throws Exception;