Javadoc warning cleanup

This commit is contained in:
Nick 2016-01-01 10:52:42 -08:00
parent d4b5d3d3e2
commit 7ebd59382f
11 changed files with 103 additions and 23 deletions

View file

@ -31,6 +31,9 @@ public class AltarComponent
/**
* Use for setting a location at which there must be a block, but the type
* of block does not matter.
*
* @param offset
* - Where the block should be in relation to the Altar
*/
public AltarComponent(BlockPos offset)
{

View file

@ -10,8 +10,13 @@ public interface IBindable
{
/**
* Called when the player attempts to bind the item.
*
* If false, binding fails.
*
* @param player
* - The Player attempting to bind the item
* @param stack
* - The ItemStack to attempt binding
*
* @return If binding was successful.
*/
boolean onBind(EntityPlayer player, ItemStack stack);
}

View file

@ -89,6 +89,11 @@ public class SoulNetwork extends WorldSavedData
/**
* Used to syphon LP from the network
*
* @param syphon
* - The amount of LP to syphon
*
* @return The amount of LP syphoned
*/
public int syphon(int syphon)
{
@ -107,6 +112,11 @@ public class SoulNetwork extends WorldSavedData
* instead take away from the user's health.
*
* Always returns false on the client side.
*
* @param user
* - The Player to syphon from
* @param toSyphon
* - The amount of LP to syphon
*
* @return - Whether the action should be performed.
*/

View file

@ -39,7 +39,9 @@ public abstract class AreaDescriptor
* (1,1,1), calling getContainedPositions() will only give (0,0,0).
*
* @param minimumOffset
* -
* @param maximumOffset
* -
*/
public Rectangle(BlockPos minimumOffset, BlockPos maximumOffset)
{
@ -93,7 +95,9 @@ public abstract class AreaDescriptor
* minimumOffset the lowest corner
*
* @param offset1
* -
* @param offset2
* -
*/
public void setOffsets(BlockPos offset1, BlockPos offset2)
{

View file

@ -64,6 +64,11 @@ public class BindableHelper
/**
* @see BindableHelper#checkAndSetItemOwner(ItemStack, String)
*
* @param stack
* - ItemStack to check
* @param uuid
* - UUID of the Player
*/
public static boolean checkAndSetItemOwner(ItemStack stack, UUID uuid)
{

View file

@ -46,6 +46,9 @@ public class NetworkHelper
/**
* @see NetworkHelper#getSoulNetwork(String)
*
* @param uuid
* - The Player's Mojang UUID
*/
public static SoulNetwork getSoulNetwork(UUID uuid)
{
@ -54,6 +57,9 @@ public class NetworkHelper
/**
* @see NetworkHelper#getSoulNetwork(String)
*
* @param player
* - The Player
*/
public static SoulNetwork getSoulNetwork(EntityPlayer player)
{
@ -127,6 +133,16 @@ public class NetworkHelper
return !(MinecraftForge.EVENT_BUS.post(event) || event.getResult() == Event.Result.DENY) && network.syphon(event.syphon) >= toSyphon;
}
/**
* Checks if the ItemStack has a user to be syphoned from.
*
* @param stack
* - ItemStack to check
* @param toSyphon
* - Amount of LP to syphon
*
* @return - If syphoning is possible
*/
public static boolean canSyphonFromContainer(ItemStack stack, int toSyphon)
{
stack = NBTHelper.checkNBT(stack);

View file

@ -45,7 +45,12 @@ public class RitualHelper
/**
* Checks the RitualRegistry to see if the configuration of the ritual
* stones in the world is valid for the given EnumFacing.
*
*
* @param world
* - The world
* @param pos
* - Location of the MasterRitualStone
*
* @return The ID of the valid ritual
*/
public static String getValidRitual(World world, BlockPos pos)
@ -126,10 +131,7 @@ public class RitualHelper
* Adds your Ritual to the {@link RitualRegistry#enabledRituals} Map. This
* is used to determine whether your effect is enabled or not.
*
* The config option will be created as {@code B:ClassName=true} with a
* comment of {@code Enables the ClassName ritual}.
*
* Use {@link #}
* The config option will be created as {@code B:ClassName=true}.
*
* Should be safe to modify at any point.
*