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 void setStoredSize(int dim, int targetX, int targetY, int targetZ)
 	/**
 	 * lazy loading, can load any id, even ones that don't exist anymore.
 	 * 
-	 * @param storageID
-	 * @return
+	 * @param storageID ID of grid storage
+	 * @return corresponding grid storage
 	 */
 	public GridStorage getGridStorage(long storageID)
 	{

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

@@ -226,21 +226,21 @@ private void addDust(String name, ItemStack item)
 	}
 
 	@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 @@ private void considerItem(String ore, ItemStack item, String Name, double weight
 	}
 
 	@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, "MeatCooked", 32 );
-		considerItem( Name, item, "Meat", 32 );
-		considerItem( Name, item, "Chicken", 32 );
-		considerItem( Name, item, "Beef", 32 );
-		considerItem( Name, item, "Sheep", 32 );
-		considerItem( Name, item, "Fish", 32 );
+		considerItem( name, item, "MeatRaw", 32 );
+		considerItem( name, item, "MeatCooked", 32 );
+		considerItem( name, item, "Meat", 32 );
+		considerItem( name, item, "Chicken", 32 );
+		considerItem( name, item, "Beef", 32 );
+		considerItem( name, item, "Sheep", 32 );
+		considerItem( name, item, "Fish", 32 );
 
 		// real world...
-		considerItem( Name, item, "Lithium", 6.941 );
-		considerItem( Name, item, "Beryllium", 9.0122 );
-		considerItem( Name, item, "Boron", 10.811 );
-		considerItem( Name, item, "Carbon", 12.0107 );
-		considerItem( Name, item, "Coal", 12.0107 );
-		considerItem( Name, item, "Charcoal", 12.0107 );
-		considerItem( Name, item, "Sodium", 22.9897 );
-		considerItem( Name, item, "Magnesium", 24.305 );
-		considerItem( Name, item, "Aluminum", 26.9815 );
-		considerItem( Name, item, "Silicon", 28.0855 );
-		considerItem( Name, item, "Phosphorus", 30.9738 );
-		considerItem( Name, item, "Sulfur", 32.065 );
-		considerItem( Name, item, "Potassium", 39.0983 );
-		considerItem( Name, item, "Calcium", 40.078 );
-		considerItem( Name, item, "Scandium", 44.9559 );
-		considerItem( Name, item, "Titanium", 47.867 );
-		considerItem( Name, item, "Vanadium", 50.9415 );
-		considerItem( Name, item, "Manganese", 54.938 );
-		considerItem( Name, item, "Iron", 55.845 );
-		considerItem( Name, item, "Nickel", 58.6934 );
-		considerItem( Name, item, "Cobalt", 58.9332 );
-		considerItem( Name, item, "Copper", 63.546 );
-		considerItem( Name, item, "Zinc", 65.39 );
-		considerItem( Name, item, "Gallium", 69.723 );
-		considerItem( Name, item, "Germanium", 72.64 );
-		considerItem( Name, item, "Bromine", 79.904 );
-		considerItem( Name, item, "Krypton", 83.8 );
-		considerItem( Name, item, "Rubidium", 85.4678 );
-		considerItem( Name, item, "Strontium", 87.62 );
-		considerItem( Name, item, "Yttrium", 88.9059 );
-		considerItem( Name, item, "Zirconiumm", 91.224 );
-		considerItem( Name, item, "Niobiumm", 92.9064 );
-		considerItem( Name, item, "Technetium", 98 );
-		considerItem( Name, item, "Ruthenium", 101.07 );
-		considerItem( Name, item, "Rhodium", 102.9055 );
-		considerItem( Name, item, "Palladium", 106.42 );
-		considerItem( Name, item, "Silver", 107.8682 );
-		considerItem( Name, item, "Cadmium", 112.411 );
-		considerItem( Name, item, "Indium", 114.818 );
-		considerItem( Name, item, "Tin", 118.71 );
-		considerItem( Name, item, "Antimony", 121.76 );
-		considerItem( Name, item, "Iodine", 126.9045 );
-		considerItem( Name, item, "Tellurium", 127.6 );
-		considerItem( Name, item, "Xenon", 131.293 );
-		considerItem( Name, item, "Cesium", 132.9055 );
-		considerItem( Name, item, "Barium", 137.327 );
-		considerItem( Name, item, "Lanthanum", 138.9055 );
-		considerItem( Name, item, "Cerium", 140.116 );
-		considerItem( Name, item, "Tantalum", 180.9479 );
-		considerItem( Name, item, "Tungsten", 183.84 );
-		considerItem( Name, item, "Osmium", 190.23 );
-		considerItem( Name, item, "Iridium", 192.217 );
-		considerItem( Name, item, "Platinum", 195.078 );
-		considerItem( Name, item, "Lead", 207.2 );
-		considerItem( Name, item, "Bismuth", 208.9804 );
-		considerItem( Name, item, "Uranium", 238.0289 );
-		considerItem( Name, item, "Plutonium", 244 );
+		considerItem( name, item, "Lithium", 6.941 );
+		considerItem( name, item, "Beryllium", 9.0122 );
+		considerItem( name, item, "Boron", 10.811 );
+		considerItem( name, item, "Carbon", 12.0107 );
+		considerItem( name, item, "Coal", 12.0107 );
+		considerItem( name, item, "Charcoal", 12.0107 );
+		considerItem( name, item, "Sodium", 22.9897 );
+		considerItem( name, item, "Magnesium", 24.305 );
+		considerItem( name, item, "Aluminum", 26.9815 );
+		considerItem( name, item, "Silicon", 28.0855 );
+		considerItem( name, item, "Phosphorus", 30.9738 );
+		considerItem( name, item, "Sulfur", 32.065 );
+		considerItem( name, item, "Potassium", 39.0983 );
+		considerItem( name, item, "Calcium", 40.078 );
+		considerItem( name, item, "Scandium", 44.9559 );
+		considerItem( name, item, "Titanium", 47.867 );
+		considerItem( name, item, "Vanadium", 50.9415 );
+		considerItem( name, item, "Manganese", 54.938 );
+		considerItem( name, item, "Iron", 55.845 );
+		considerItem( name, item, "Nickel", 58.6934 );
+		considerItem( name, item, "Cobalt", 58.9332 );
+		considerItem( name, item, "Copper", 63.546 );
+		considerItem( name, item, "Zinc", 65.39 );
+		considerItem( name, item, "Gallium", 69.723 );
+		considerItem( name, item, "Germanium", 72.64 );
+		considerItem( name, item, "Bromine", 79.904 );
+		considerItem( name, item, "Krypton", 83.8 );
+		considerItem( name, item, "Rubidium", 85.4678 );
+		considerItem( name, item, "Strontium", 87.62 );
+		considerItem( name, item, "Yttrium", 88.9059 );
+		considerItem( name, item, "Zirconiumm", 91.224 );
+		considerItem( name, item, "Niobiumm", 92.9064 );
+		considerItem( name, item, "Technetium", 98 );
+		considerItem( name, item, "Ruthenium", 101.07 );
+		considerItem( name, item, "Rhodium", 102.9055 );
+		considerItem( name, item, "Palladium", 106.42 );
+		considerItem( name, item, "Silver", 107.8682 );
+		considerItem( name, item, "Cadmium", 112.411 );
+		considerItem( name, item, "Indium", 114.818 );
+		considerItem( name, item, "Tin", 118.71 );
+		considerItem( name, item, "Antimony", 121.76 );
+		considerItem( name, item, "Iodine", 126.9045 );
+		considerItem( name, item, "Tellurium", 127.6 );
+		considerItem( name, item, "Xenon", 131.293 );
+		considerItem( name, item, "Cesium", 132.9055 );
+		considerItem( name, item, "Barium", 137.327 );
+		considerItem( name, item, "Lanthanum", 138.9055 );
+		considerItem( name, item, "Cerium", 140.116 );
+		considerItem( name, item, "Tantalum", 180.9479 );
+		considerItem( name, item, "Tungsten", 183.84 );
+		considerItem( name, item, "Osmium", 190.23 );
+		considerItem( name, item, "Iridium", 192.217 );
+		considerItem( name, item, "Platinum", 195.078 );
+		considerItem( name, item, "Lead", 207.2 );
+		considerItem( name, item, "Bismuth", 208.9804 );
+		considerItem( name, item, "Uranium", 238.0289 );
+		considerItem( name, item, "Plutonium", 244 );
 
 		// TE stuff...
-		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, "Invar", (58.6934 + 55.845 + 55.845) / 3.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 World getWorld()
 	/**
 	 * returns true if this needs more simulation.
 	 * 
-	 * @param milli
-	 * @return
+	 * @param milli milliseconds of simulation
+	 * @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 ToolMemoryCard() {
 	/**
 	 * Find the localized string...
 	 * 
-	 * @param name
-	 * @return
+	 * @param name possible names for the localized string
+	 * @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 gss
+	 * @param id ID of grid storage
+	 * @param gss grid storage search
 	 */
 	public GridStorage(long id, GridStorageSearch gss) {
 		myID = id;
@@ -41,9 +41,9 @@ public GridStorage(long id, GridStorageSearch gss) {
 	/**
 	 * for use with world settings
 	 * 
-	 * @param input
-	 * @param id
-	 * @param gss
+	 * @param input array of bytes string
+	 * @param id ID of grid storage
+	 * @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 MBCalculator(IAEMultiBlock t) {
 	/**
 	 * check if the tile entities are correct for the structure.
 	 * 
-	 * @param te
-	 * @return
+	 * @param te to be checked tile entity
+	 * @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 min
-	 * @param max
-	 * @return
+	 * @param w world
+	 * @param min min world coord
+	 * @param max max world coord
+	 * @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 w
-	 * @param min
-	 * @param max
+	 * @param c updated cluster
+	 * @param w in world
+	 * @param min min world coord
+	 * @param max max world coord
 	 */
 	public abstract void updateTiles(IAECluster c, World w, WorldCoord min, WorldCoord max);
 
@@ -52,9 +52,9 @@ public MBCalculator(IAEMultiBlock t) {
 	/**
 	 * verify if the structure is the correct dimensions, or size
 	 * 
-	 * @param min
-	 * @param max
-	 * @return
+	 * @param min min world coord
+	 * @param max max world coord
+	 * @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 IGridHost getMachine()
 	/**
 	 * short cut!
 	 * 
-	 * @return
-	 * @throws GridAccessException
+	 * @return grid of node
+	 * @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 int getInstalledUpgrades(Upgrades u)
 	/**
 	 * depending on the from, different settings will be accepted, don't call this with null
 	 * 
-	 * @param from
-	 * @param compound
+	 * @param from source of settings
+	 * @param compound compound of source
 	 */
 	public void uploadSettings(SettingsFrom from, NBTTagCompound compound)
 	{
@@ -329,8 +329,8 @@ public void uploadSettings(SettingsFrom from, NBTTagCompound compound)
 	/**
 	 * null means nothing to store...
 	 * 
-	 * @param from
-	 * @return
+	 * @param from source of settings
+	 * @return compound of source
 	 */
 	public NBTTagCompound downloadSettings(SettingsFrom from)
 	{

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

@@ -26,7 +26,7 @@ public InvLayerData(int a[][], List<ISidedInventory> b, List<InvSot> c) {
 	/**
 	 * 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 item
+	 * @param name name of ore
+	 * @param item item with name
 	 */
-	void oreRegistered(String Name, ItemStack item);
+	void oreRegistered(String name, ItemStack item);
 
 }