Merge pull request #142 from thatsIch/Javadocs

Fixing internal javadoc

src/main/java/appeng/client/gui/widgets/ITooltip.java

@@ -10,7 +10,7 @@ public interface ITooltip
 	/**
 	 * returns the tooltip message.
 	 * 
-	 * @return
+	 * @return tooltip message
 	 */
 	String getMsg();
 

src/main/java/appeng/core/WorldSettings.java

@@ -338,8 +338,8 @@ public class WorldSettings extends Configuration
 	/**
 	 * lazy loading, can load any id, even ones that don't exist anymore.
 	 * 
-	 * @param storageID
+	 * @param storageID ID of grid storage
-	 * @return
+	 * @return corresponding grid storage
 	 */
 	public GridStorage getGridStorage(long storageID)
 	{

src/main/java/appeng/core/features/registries/GrinderRecipeManager.java

@@ -226,21 +226,21 @@ public class GrinderRecipeManager implements IGrinderRegistry, IOreListener
 	}
 
 	@Override
-	public void oreRegistered(String Name, ItemStack item)
+	public void oreRegistered(String name, ItemStack item)
 	{
-		if ( Name.startsWith( "ore" ) || Name.startsWith( "crystal" ) || Name.startsWith( "gem" ) || Name.startsWith( "ingot" ) || Name.startsWith( "dust" ) )
+		if ( name.startsWith( "ore" ) || name.startsWith( "crystal" ) || name.startsWith( "gem" ) || name.startsWith( "ingot" ) || name.startsWith( "dust" ) )
 		{
 			for (String ore : AEConfig.instance.grinderOres)
 			{
-				if ( Name.equals( "ore" + ore ) )
+				if ( name.equals( "ore" + ore ) )
 				{
 					addOre( ore, item );
 				}
-				else if ( Name.equals( "crystal" + ore ) || Name.equals( "ingot" + ore ) || Name.equals( "gem" + ore ) )
+				else if ( name.equals( "crystal" + ore ) || name.equals( "ingot" + ore ) || name.equals( "gem" + ore ) )
 				{
 					addIngot( ore, item );
 				}
-				else if ( Name.equals( "dust" + ore ) )
+				else if ( name.equals( "dust" + ore ) )
 				{
 					addDust( ore, item );
 				}

src/main/java/appeng/core/features/registries/MatterCannonAmmoRegistry.java

@@ -29,82 +29,82 @@ public class MatterCannonAmmoRegistry implements IOreListener, IMatterCannonAmmo
 	}
 
 	@Override
-	public void oreRegistered(String Name, ItemStack item)
+	public void oreRegistered(String name, ItemStack item)
 	{
-		if ( !(Name.startsWith( "berry" ) || Name.startsWith( "nugget" )) )
+		if ( !(name.startsWith( "berry" ) || name.startsWith( "nugget" )) )
 			return;
 
 		// addNugget( "Cobble", 18 ); // ?
-		considerItem( Name, item, "MeatRaw", 32 );
+		considerItem( name, item, "MeatRaw", 32 );
-		considerItem( Name, item, "MeatCooked", 32 );
+		considerItem( name, item, "MeatCooked", 32 );
-		considerItem( Name, item, "Meat", 32 );
+		considerItem( name, item, "Meat", 32 );
-		considerItem( Name, item, "Chicken", 32 );
+		considerItem( name, item, "Chicken", 32 );
-		considerItem( Name, item, "Beef", 32 );
+		considerItem( name, item, "Beef", 32 );
-		considerItem( Name, item, "Sheep", 32 );
+		considerItem( name, item, "Sheep", 32 );
-		considerItem( Name, item, "Fish", 32 );
+		considerItem( name, item, "Fish", 32 );
 
 		// real world...
-		considerItem( Name, item, "Lithium", 6.941 );
+		considerItem( name, item, "Lithium", 6.941 );
-		considerItem( Name, item, "Beryllium", 9.0122 );
+		considerItem( name, item, "Beryllium", 9.0122 );
-		considerItem( Name, item, "Boron", 10.811 );
+		considerItem( name, item, "Boron", 10.811 );
-		considerItem( Name, item, "Carbon", 12.0107 );
+		considerItem( name, item, "Carbon", 12.0107 );
-		considerItem( Name, item, "Coal", 12.0107 );
+		considerItem( name, item, "Coal", 12.0107 );
-		considerItem( Name, item, "Charcoal", 12.0107 );
+		considerItem( name, item, "Charcoal", 12.0107 );
-		considerItem( Name, item, "Sodium", 22.9897 );
+		considerItem( name, item, "Sodium", 22.9897 );
-		considerItem( Name, item, "Magnesium", 24.305 );
+		considerItem( name, item, "Magnesium", 24.305 );
-		considerItem( Name, item, "Aluminum", 26.9815 );
+		considerItem( name, item, "Aluminum", 26.9815 );
-		considerItem( Name, item, "Silicon", 28.0855 );
+		considerItem( name, item, "Silicon", 28.0855 );
-		considerItem( Name, item, "Phosphorus", 30.9738 );
+		considerItem( name, item, "Phosphorus", 30.9738 );
-		considerItem( Name, item, "Sulfur", 32.065 );
+		considerItem( name, item, "Sulfur", 32.065 );
-		considerItem( Name, item, "Potassium", 39.0983 );
+		considerItem( name, item, "Potassium", 39.0983 );
-		considerItem( Name, item, "Calcium", 40.078 );
+		considerItem( name, item, "Calcium", 40.078 );
-		considerItem( Name, item, "Scandium", 44.9559 );
+		considerItem( name, item, "Scandium", 44.9559 );
-		considerItem( Name, item, "Titanium", 47.867 );
+		considerItem( name, item, "Titanium", 47.867 );
-		considerItem( Name, item, "Vanadium", 50.9415 );
+		considerItem( name, item, "Vanadium", 50.9415 );
-		considerItem( Name, item, "Manganese", 54.938 );
+		considerItem( name, item, "Manganese", 54.938 );
-		considerItem( Name, item, "Iron", 55.845 );
+		considerItem( name, item, "Iron", 55.845 );
-		considerItem( Name, item, "Nickel", 58.6934 );
+		considerItem( name, item, "Nickel", 58.6934 );
-		considerItem( Name, item, "Cobalt", 58.9332 );
+		considerItem( name, item, "Cobalt", 58.9332 );
-		considerItem( Name, item, "Copper", 63.546 );
+		considerItem( name, item, "Copper", 63.546 );
-		considerItem( Name, item, "Zinc", 65.39 );
+		considerItem( name, item, "Zinc", 65.39 );
-		considerItem( Name, item, "Gallium", 69.723 );
+		considerItem( name, item, "Gallium", 69.723 );
-		considerItem( Name, item, "Germanium", 72.64 );
+		considerItem( name, item, "Germanium", 72.64 );
-		considerItem( Name, item, "Bromine", 79.904 );
+		considerItem( name, item, "Bromine", 79.904 );
-		considerItem( Name, item, "Krypton", 83.8 );
+		considerItem( name, item, "Krypton", 83.8 );
-		considerItem( Name, item, "Rubidium", 85.4678 );
+		considerItem( name, item, "Rubidium", 85.4678 );
-		considerItem( Name, item, "Strontium", 87.62 );
+		considerItem( name, item, "Strontium", 87.62 );
-		considerItem( Name, item, "Yttrium", 88.9059 );
+		considerItem( name, item, "Yttrium", 88.9059 );
-		considerItem( Name, item, "Zirconiumm", 91.224 );
+		considerItem( name, item, "Zirconiumm", 91.224 );
-		considerItem( Name, item, "Niobiumm", 92.9064 );
+		considerItem( name, item, "Niobiumm", 92.9064 );
-		considerItem( Name, item, "Technetium", 98 );
+		considerItem( name, item, "Technetium", 98 );
-		considerItem( Name, item, "Ruthenium", 101.07 );
+		considerItem( name, item, "Ruthenium", 101.07 );
-		considerItem( Name, item, "Rhodium", 102.9055 );
+		considerItem( name, item, "Rhodium", 102.9055 );
-		considerItem( Name, item, "Palladium", 106.42 );
+		considerItem( name, item, "Palladium", 106.42 );
-		considerItem( Name, item, "Silver", 107.8682 );
+		considerItem( name, item, "Silver", 107.8682 );
-		considerItem( Name, item, "Cadmium", 112.411 );
+		considerItem( name, item, "Cadmium", 112.411 );
-		considerItem( Name, item, "Indium", 114.818 );
+		considerItem( name, item, "Indium", 114.818 );
-		considerItem( Name, item, "Tin", 118.71 );
+		considerItem( name, item, "Tin", 118.71 );
-		considerItem( Name, item, "Antimony", 121.76 );
+		considerItem( name, item, "Antimony", 121.76 );
-		considerItem( Name, item, "Iodine", 126.9045 );
+		considerItem( name, item, "Iodine", 126.9045 );
-		considerItem( Name, item, "Tellurium", 127.6 );
+		considerItem( name, item, "Tellurium", 127.6 );
-		considerItem( Name, item, "Xenon", 131.293 );
+		considerItem( name, item, "Xenon", 131.293 );
-		considerItem( Name, item, "Cesium", 132.9055 );
+		considerItem( name, item, "Cesium", 132.9055 );
-		considerItem( Name, item, "Barium", 137.327 );
+		considerItem( name, item, "Barium", 137.327 );
-		considerItem( Name, item, "Lanthanum", 138.9055 );
+		considerItem( name, item, "Lanthanum", 138.9055 );
-		considerItem( Name, item, "Cerium", 140.116 );
+		considerItem( name, item, "Cerium", 140.116 );
-		considerItem( Name, item, "Tantalum", 180.9479 );
+		considerItem( name, item, "Tantalum", 180.9479 );
-		considerItem( Name, item, "Tungsten", 183.84 );
+		considerItem( name, item, "Tungsten", 183.84 );
-		considerItem( Name, item, "Osmium", 190.23 );
+		considerItem( name, item, "Osmium", 190.23 );
-		considerItem( Name, item, "Iridium", 192.217 );
+		considerItem( name, item, "Iridium", 192.217 );
-		considerItem( Name, item, "Platinum", 195.078 );
+		considerItem( name, item, "Platinum", 195.078 );
-		considerItem( Name, item, "Lead", 207.2 );
+		considerItem( name, item, "Lead", 207.2 );
-		considerItem( Name, item, "Bismuth", 208.9804 );
+		considerItem( name, item, "Bismuth", 208.9804 );
-		considerItem( Name, item, "Uranium", 238.0289 );
+		considerItem( name, item, "Uranium", 238.0289 );
-		considerItem( Name, item, "Plutonium", 244 );
+		considerItem( name, item, "Plutonium", 244 );
 
 		// TE stuff...
-		considerItem( Name, item, "Invar", (58.6934 + 55.845 + 55.845) / 3.0 );
+		considerItem( name, item, "Invar", (58.6934 + 55.845 + 55.845) / 3.0 );
-		considerItem( Name, item, "Electrum", (107.8682 + 196.96655) / 2.0 );
+		considerItem( name, item, "Electrum", (107.8682 + 196.96655) / 2.0 );
 	}
 
 	public MatterCannonAmmoRegistry() {

src/main/java/appeng/crafting/CraftingJob.java

@@ -261,8 +261,8 @@ public class CraftingJob implements Runnable, ICraftingJob
 	/**
 	 * returns true if this needs more simulation.
 	 * 
-	 * @param milli
+	 * @param milli milliseconds of simulation
-	 * @return
+	 * @return true if this needs more simulation
 	 */
 	public boolean simulateFor(int milli)
 	{

src/main/java/appeng/helpers/IContainerCraftingPacket.java

@@ -14,7 +14,7 @@ public interface IContainerCraftingPacket
 	IGridNode getNetworkNode();
 
 	/**
-	 * @param string
+	 * @param string name of inventory
 	 * @return the inventory of the part/tile by name.
 	 */
 	IInventory getInventoryByName(String string);

src/main/java/appeng/integration/abstraction/IImmibisMicroblocks.java

@@ -10,7 +10,7 @@ public interface IImmibisMicroblocks
 	IPartHost getOrCreateHost(EntityPlayer player, int side, TileEntity te);
 
 	/**
-	 * @param te
+	 * @param te to be left tile entity
 	 * @return true if this worked..
 	 */
 	boolean leaveParts(TileEntity te);

src/main/java/appeng/items/tools/ToolMemoryCard.java

@@ -28,8 +28,8 @@ public class ToolMemoryCard extends AEBaseItem implements IMemoryCard
 	/**
 	 * Find the localized string...
 	 * 
-	 * @param name
+	 * @param name possible names for the localized string
-	 * @return
+	 * @return localized name
 	 */
 	private String getLocalizedName(String... name)
 	{

src/main/java/appeng/me/GridStorage.java

@@ -29,8 +29,8 @@ public class GridStorage implements IGridStorage
 	/**
 	 * for use with world settings
 	 * 
-	 * @param id
+	 * @param id ID of grid storage
-	 * @param gss
+	 * @param gss grid storage search
 	 */
 	public GridStorage(long id, GridStorageSearch gss) {
 		myID = id;
@@ -41,9 +41,9 @@ public class GridStorage implements IGridStorage
 	/**
 	 * for use with world settings
 	 * 
-	 * @param input
+	 * @param input array of bytes string
-	 * @param id
+	 * @param id ID of grid storage
-	 * @param gss
+	 * @param gss grid storage search
 	 */
 	public GridStorage(String input, long id, GridStorageSearch gss) {
 		myID = id;

src/main/java/appeng/me/GridStorageSearch.java

@@ -11,7 +11,7 @@ public class GridStorageSearch
 	/**
 	 * for use with the world settings
 	 * 
-	 * @param id
+	 * @param id ID of grid storage search
 	 */
 	public GridStorageSearch(long id) {
 		this.id = id;

src/main/java/appeng/me/cluster/MBCalculator.java

@@ -19,28 +19,28 @@ public abstract class MBCalculator
 	/**
 	 * check if the tile entities are correct for the structure.
 	 * 
-	 * @param te
+	 * @param te to be checked tile entity
-	 * @return
+	 * @return true if tile entity is valid for structure
 	 */
 	public abstract boolean isValidTile(TileEntity te);
 
 	/**
 	 * construct the correct cluster, usually very simple.
 	 * 
-	 * @param w
+	 * @param w world
-	 * @param min
+	 * @param min min world coord
-	 * @param max
+	 * @param max max world coord
-	 * @return
+	 * @return created cluster
 	 */
 	public abstract IAECluster createCluster(World w, WorldCoord min, WorldCoord max);
 
 	/**
 	 * configure the mutli-block tiles, most of the important stuff is in here.
 	 * 
-	 * @param c
+	 * @param c updated cluster
-	 * @param w
+	 * @param w in world
-	 * @param min
+	 * @param min min world coord
-	 * @param max
+	 * @param max max world coord
 	 */
 	public abstract void updateTiles(IAECluster c, World w, WorldCoord min, WorldCoord max);
 
@@ -52,9 +52,9 @@ public abstract class MBCalculator
 	/**
 	 * verify if the structure is the correct dimensions, or size
 	 * 
-	 * @param min
+	 * @param min min world coord
-	 * @param max
+	 * @param max max world coord
-	 * @return
+	 * @return true if structure has correct dimensions or size
 	 */
 	public abstract boolean checkMultiblockScale(WorldCoord min, WorldCoord max);
 

src/main/java/appeng/me/helpers/AENetworkProxy.java

@@ -189,8 +189,8 @@ public class AENetworkProxy implements IGridBlock
 	/**
 	 * short cut!
 	 * 
-	 * @return
+	 * @return grid of node
-	 * @throws GridAccessException
+	 * @throws GridAccessException of node or grid is null
 	 */
 	public IGrid getGrid() throws GridAccessException
 	{

src/main/java/appeng/me/pathfinding/IPathItem.java

@@ -36,8 +36,6 @@ public interface IPathItem
 
 	/**
 	 * channels are done, wrap it up.
-	 * 
-	 * @return
 	 */
 	void finalizeChannels();
 

src/main/java/appeng/parts/AEBasePart.java

@@ -294,8 +294,8 @@ public class AEBasePart implements IPart, IGridProxyable, IActionHost, IUpgradea
 	/**
 	 * depending on the from, different settings will be accepted, don't call this with null
 	 * 
-	 * @param from
+	 * @param from source of settings
-	 * @param compound
+	 * @param compound compound of source
 	 */
 	public void uploadSettings(SettingsFrom from, NBTTagCompound compound)
 	{
@@ -329,8 +329,8 @@ public class AEBasePart implements IPart, IGridProxyable, IActionHost, IUpgradea
 	/**
 	 * null means nothing to store...
 	 * 
-	 * @param from
+	 * @param from source of settings
-	 * @return
+	 * @return compound of source
 	 */
 	public NBTTagCompound downloadSettings(SettingsFrom from)
 	{

src/main/java/appeng/parts/layers/InvLayerData.java

@@ -26,7 +26,7 @@ public class InvLayerData
 	/**
 	 * check if a slot index is valid, prevent crashes from bad code :)
 	 * 
-	 * @param slot
+	 * @param slot slot index
 	 * @return true, if the slot exists.
 	 */
 	boolean isSlotValid(int slot)

src/main/java/appeng/recipes/ores/IOreListener.java

@@ -9,9 +9,9 @@ public interface IOreListener
 	 * Called with various items registered in the dictionary.
 	 * AppEng.oreDictionary.observe(...) to register them.
 	 * 
-	 * @param Name
+	 * @param name name of ore
-	 * @param item
+	 * @param item item with name
 	 */
-	void oreRegistered(String Name, ItemStack item);
+	void oreRegistered(String name, ItemStack item);
 
 }

src/main/java/appeng/recipes/ores/OreDictionaryHandler.java

@@ -22,8 +22,8 @@ public class OreDictionaryHandler
 	/**
 	 * Just limit what items are sent to the final listeners, I got sick of strange items showing up...
 	 * 
-	 * @param name
+	 * @param name name about cared item
-	 * @return
+	 * @return true if it should care
 	 */
 	private boolean shouldCare(String name)
 	{
@@ -50,7 +50,7 @@ public class OreDictionaryHandler
 	 * Adds a new IOreListener and immediately notifies it of any previous ores, any ores added latter will be added at
 	 * that point.
 	 * 
-	 * @param n
+	 * @param n to be added ore listener
 	 */
 	public void observe(IOreListener n)
 	{

src/main/java/appeng/services/helpers/ICompassCallback.java

@@ -6,9 +6,10 @@ public interface ICompassCallback
 	/**
 	 * Called from another thread.
 	 * 
-	 * @param hasResult
+	 * @param hasResult true if found a target
-	 * @param spin
+	 * @param spin true if should spin
-	 * @param radians
+	 * @param radians radians
+	 * @param dist distance
 	 */
 	public void calculatedDirection(boolean hasResult, boolean spin, double radians, double dist);
 

src/main/java/appeng/spatial/DefaultSpatialHandler.java

@@ -31,8 +31,8 @@ public class DefaultSpatialHandler implements IMovableHandler
 	/**
 	 * never called for the default.
 	 * 
-	 * @param tile
+	 * @param tile tile entity
-	 * @return
+	 * @return true
 	 */
 	@Override
 	public boolean canHandle(Class<? extends TileEntity> myClass, TileEntity tile)

src/main/java/appeng/spatial/StorageHelper.java

@@ -133,10 +133,9 @@ public class StorageHelper
 	/**
 	 * Mostly from dimensional doors.. which mostly got it form X-Comp.
 	 * 
-	 * @param world
+	 * @param entity to be teleported entity
-	 * @param entity
+	 * @param link destination
-	 * @param link
+	 * @return teleported entity
-	 * @return
 	 */
 	public Entity teleportEntity(Entity entity, TelDestination link)
 	{

src/main/java/appeng/tile/AEBaseTile.java

@@ -267,7 +267,7 @@ public class AEBaseTile extends TileEntity implements IOrientable, ICommonTile,
 	/**
 	 * By default all blocks can have orientation, this handles saving, and loading, as well as synchronization.
 	 * 
-	 * @return
+	 * @return true if tile can be rotated
 	 */
 	@Override
 	public boolean canBeRotated()
@@ -357,11 +357,11 @@ public class AEBaseTile extends TileEntity implements IOrientable, ICommonTile,
 	/**
 	 * returns the contents of the tile entity, into the world, defaults to dropping everything in the inventory.
 	 * 
-	 * @param w
+	 * @param w world
-	 * @param x
+	 * @param x x pos of tile entity
-	 * @param y
+	 * @param y y pos of tile entity
-	 * @param z
+	 * @param z z pos of tile entity
-	 * @param drops
+	 * @param drops drops of tile entity
 	 */
 	@Override
 	public void getDrops(World w, int x, int y, int z, ArrayList<ItemStack> drops)
@@ -393,8 +393,8 @@ public class AEBaseTile extends TileEntity implements IOrientable, ICommonTile,
 	/**
 	 * depending on the from, different settings will be accepted, don't call this with null
 	 * 
-	 * @param from
+	 * @param from source of settings
-	 * @param compound
+	 * @param compound compound of source
 	 */
 	public void uploadSettings(SettingsFrom from, NBTTagCompound compound)
 	{
@@ -428,8 +428,8 @@ public class AEBaseTile extends TileEntity implements IOrientable, ICommonTile,
 	/**
 	 * null means nothing to store...
 	 * 
-	 * @param from
+	 * @param from source of settings
-	 * @return
+	 * @return compound of source
 	 */
 	public NBTTagCompound downloadSettings(SettingsFrom from)
 	{

src/main/java/appeng/tile/events/AETileEventHandler.java

@@ -110,8 +110,8 @@ public class AETileEventHandler
 	/**
 	 * returning true from this method, will update the block's render
 	 * 
-	 * @param data
+	 * @param data data of stream
-	 * @return
+	 * @return true of method could be invoked
 	 * @throws IOException
 	 */
 	@SideOnly(Side.CLIENT)

src/main/java/appeng/tile/misc/TileCondenser.java

@@ -96,7 +96,7 @@ public class TileCondenser extends AEBaseInvTile implements IAEAppEngInventory,
 	/**
 	 * make sure you validate with canAddOutput prior to this.
 	 * 
-	 * @param output
+	 * @param output to be added output
 	 */
 	private void addOutput(ItemStack output)
 	{

src/main/java/appeng/util/ConfigManager.java

@@ -20,7 +20,7 @@ public class ConfigManager implements IConfigManager
 	/**
 	 * read all settings using config manager.
 	 * 
-	 * @param tagCompound
+	 * @param tagCompound to be read from compound
 	 */
 	@Override
 	public void readFromNBT(NBTTagCompound tagCompound)
@@ -49,7 +49,7 @@ public class ConfigManager implements IConfigManager
 	/**
 	 * save all settings using config manager.
 	 * 
-	 * @param tagCompound
+	 * @param tagCompound to be written to compound
 	 */
 	@Override
 	public void writeToNBT(NBTTagCompound tagCompound)

src/main/java/appeng/util/Platform.java

@@ -147,9 +147,9 @@ public class Platform
 	/**
 	 * This displays the value for encoded longs ( double *100 )
 	 * 
-	 * @param n
+	 * @param n to be formatted long value
-	 * @param isRate
+	 * @param isRate if true it adds a /t to the formatted string
-	 * @return
+	 * @return formatted long value
 	 */
 	public static String formatPowerLong(long n, boolean isRate)
 	{