Clean up some javadoc warnings.

This commit is contained in:
LexManos 2012-09-11 13:11:17 -07:00
parent 848837bd5c
commit da501613ac
6 changed files with 21 additions and 20 deletions

View file

@ -17,7 +17,7 @@ import net.minecraft.src.*;
public class ModCompatibilityClient public class ModCompatibilityClient
{ {
/** /**
* Trys to get the class for the specified name, will also try the * Tries to get the class for the specified name, will also try the
* net.minecraft.src package in case we are in MCP * net.minecraft.src package in case we are in MCP
* Returns null if not found. * Returns null if not found.
* *
@ -77,6 +77,7 @@ public class ModCompatibilityClient
/** /**
* Walks the given path in the Minecraft app directory and adds audio to the SoundPool * Walks the given path in the Minecraft app directory and adds audio to the SoundPool
*
* @param path The path to walk * @param path The path to walk
* @param pool The pool to add sound to * @param pool The pool to add sound to
*/ */

View file

@ -31,7 +31,7 @@ public interface ISpecialArmor
* same priority, damage will be distributed between them based on there * same priority, damage will be distributed between them based on there
* absorption ratio. * absorption ratio.
* *
* @param entity The entity wearing the armor. * @param player The entity wearing the armor.
* @param armor The ItemStack of the armor item itself. * @param armor The ItemStack of the armor item itself.
* @param source The source of the damage, which can be used to alter armor * @param source The source of the damage, which can be used to alter armor
* properties based on the type or source of damage. * properties based on the type or source of damage.
@ -57,7 +57,7 @@ public interface ISpecialArmor
* up automatically. * up automatically.
* *
* @param entity The entity wearing the armor * @param entity The entity wearing the armor
* @param armor The ItemStack of the armor item itself. * @param stack The ItemStack of the armor item itself.
* @param source The source of the damage, which can be used to alter armor * @param source The source of the damage, which can be used to alter armor
* properties based on the type or source of damage. * properties based on the type or source of damage.
* @param damage The amount of damage being applied to the armor * @param damage The amount of damage being applied to the armor

View file

@ -71,7 +71,7 @@ public class MinecraftForge
* classes, if multiple tool types can be used to harvest this block. * classes, if multiple tool types can be used to harvest this block.
* @param harvestLevel The minimum tool harvest level required to successfully * @param harvestLevel The minimum tool harvest level required to successfully
* harvest the block. * harvest the block.
* @see setToolClass for details on tool classes. * @see MinecraftForge#setToolClass for details on tool classes.
*/ */
public static void setBlockHarvestLevel(Block block, int metadata, String toolClass, int harvestLevel) public static void setBlockHarvestLevel(Block block, int metadata, String toolClass, int harvestLevel)
{ {
@ -90,7 +90,7 @@ public class MinecraftForge
* @param block The block to remove effectiveness from. * @param block The block to remove effectiveness from.
* @param metadata The metadata for the block subtype. * @param metadata The metadata for the block subtype.
* @param toolClass The tool class to remove the effectiveness mapping from. * @param toolClass The tool class to remove the effectiveness mapping from.
* @see setToolClass for details on tool classes. * @see MinecraftForge#setToolClass for details on tool classes.
*/ */
public static void removeBlockEffectiveness(Block block, int metadata, String toolClass) public static void removeBlockEffectiveness(Block block, int metadata, String toolClass)
{ {
@ -108,7 +108,7 @@ public class MinecraftForge
* classes, if multiple tool types can be used to harvest this block. * classes, if multiple tool types can be used to harvest this block.
* @param harvestLevel The minimum tool harvest level required to successfully * @param harvestLevel The minimum tool harvest level required to successfully
* harvest the block. * harvest the block.
* @see setToolClass for details on tool classes. * @see MinecraftForge#setToolClass for details on tool classes.
*/ */
public static void setBlockHarvestLevel(Block block, String toolClass, int harvestLevel) public static void setBlockHarvestLevel(Block block, String toolClass, int harvestLevel)
{ {
@ -126,7 +126,7 @@ public class MinecraftForge
* @param block The block to check. * @param block The block to check.
* @param metadata The metadata for the block subtype. * @param metadata The metadata for the block subtype.
* @param toolClass The tool class to check as able to remove this block. * @param toolClass The tool class to check as able to remove this block.
* @see setToolClass for details on tool classes. * @see MinecraftForge#setToolClass for details on tool classes.
* @return The harvest level or -1 if no mapping exists. * @return The harvest level or -1 if no mapping exists.
*/ */
public static int getBlockHarvestLevel(Block block, int metadata, String toolClass) public static int getBlockHarvestLevel(Block block, int metadata, String toolClass)
@ -150,7 +150,7 @@ public class MinecraftForge
* *
* @param block The block to remove effectiveness from. * @param block The block to remove effectiveness from.
* @param toolClass The tool class to remove the effectiveness mapping from. * @param toolClass The tool class to remove the effectiveness mapping from.
* @see setToolClass for details on tool classes. * @see MinecraftForge#setToolClass for details on tool classes.
*/ */
public static void removeBlockEffectiveness(Block block, String toolClass) public static void removeBlockEffectiveness(Block block, String toolClass)
{ {

View file

@ -60,7 +60,7 @@ public class OreDictionary
* Retrieves the ArrayList of items that are registered to this ore type. * Retrieves the ArrayList of items that are registered to this ore type.
* Creates the list as empty if it did not exist. * Creates the list as empty if it did not exist.
* *
* @param id The ore ID, see getOreID * @param name The ore name, directly calls getOreID
* @return An arrayList containing ItemStacks registered for this ore * @return An arrayList containing ItemStacks registered for this ore
*/ */
public static ArrayList<ItemStack> getOres(String name) public static ArrayList<ItemStack> getOres(String name)

View file

@ -161,7 +161,7 @@
+ * @param x X Position + * @param x X Position
+ * @param y Y position + * @param y Y position
+ * @param z Z position + * @param z Z position
+ * @param size The side to check + * @param side The side to check
+ * @return True if the block is solid on the specified side. + * @return True if the block is solid on the specified side.
+ */ + */
+ public boolean isBlockSolidOnSide(World world, int x, int y, int z, ForgeDirection side) + public boolean isBlockSolidOnSide(World world, int x, int y, int z, ForgeDirection side)
@ -338,7 +338,7 @@
+ * @param z The blocks Z position + * @param z The blocks Z position
+ * @param metadata The blocks current metadata + * @param metadata The blocks current metadata
+ * @param side The face that the fire is coming from + * @param side The face that the fire is coming from
+ * @return + * @return True if this block sustains fire, meaning it will never go out.
+ */ + */
+ public boolean isFireSource(World world, int x, int y, int z, int metadata, ForgeDirection side) + public boolean isFireSource(World world, int x, int y, int z, int metadata, ForgeDirection side)
+ { + {
@ -416,8 +416,8 @@
+ * + *
+ * @param world The current world + * @param world The current world
+ * @param x X Position + * @param x X Position
+ * @param Y Y Position + * @param y Y Position
+ * @param Z Z Position + * @param z Z Position
+ * @param metadata Current metadata + * @param metadata Current metadata
+ * @param fortune Breakers fortune level + * @param fortune Breakers fortune level
+ * @return A ArrayList containing all items this block drops + * @return A ArrayList containing all items this block drops
@ -677,15 +677,15 @@
+ /** + /**
+ * Location sensitive version of getExplosionRestance + * Location sensitive version of getExplosionRestance
+ * + *
+ * @param par1Entity + * @param par1Entity The entity that caused the explosion
+ * @param world The current world + * @param world The current world
+ * @param x X Position + * @param x X Position
+ * @param y Y Position + * @param y Y Position
+ * @param z Z Position + * @param z Z Position
+ * @param explosionX + * @param explosionX Explosion source X Position
+ * @param explosionY + * @param explosionY Explosion source X Position
+ * @param explosionZ + * @param explosionZ Explosion source X Position
+ * @return + * @return The amount of the explosion absorbed.
+ */ + */
+ public float getExplosionResistance(Entity par1Entity, World world, int x, int y, int z, double explosionX, double explosionY, double explosionZ) + public float getExplosionResistance(Entity par1Entity, World world, int x, int y, int z, double explosionX, double explosionY, double explosionZ)
+ { + {

View file

@ -41,9 +41,9 @@
+ * @param chunkX The chunk's X position + * @param chunkX The chunk's X position
+ * @param chunkZ The Chunk's Z position + * @param chunkZ The Chunk's Z position
+ */ + */
+ public Chunk(World world, byte[] ids, byte[] metadata, int chunkX, int chunkY) + public Chunk(World world, byte[] ids, byte[] metadata, int chunkX, int chunkZ)
+ { + {
+ this(world, chunkX, chunkY); + this(world, chunkX, chunkZ);
+ int var5 = ids.length / 256; + int var5 = ids.length / 256;
+ +
+ for (int x = 0; x < 16; ++x) + for (int x = 0; x < 16; ++x)