fixed javadoc errors

This commit is contained in:
SpaceToad 2014-05-05 14:54:39 +02:00
parent 27a7d1390b
commit 9877f8df63
12 changed files with 19 additions and 25 deletions

View file

@ -270,7 +270,6 @@ public abstract class Schematic {
/**
* Return the building permission for blueprint containing this schematic.
* @return
*/
public BuildingPermission getBuildingPermission () {
return BuildingPermission.ALL;

View file

@ -18,7 +18,6 @@ public interface IIconProvider {
/**
* @param iconIndex
* @return
*/
@SideOnly(Side.CLIENT)
IIcon getIcon(int iconIndex);

View file

@ -71,11 +71,11 @@ public final class IronEngineCoolant {
}
/**
* Adds a solid coolant like Ice Blocks. The FluidStack must contain a registered
* Coolant Fluid or nothing will happen. You do not need to call this for
* Fluid Containers.
*
* @param data.stack
* Adds a solid coolant like Ice Blocks. The FluidStack must contain a
* registered Coolant Fluid or nothing will happen. You do not need to call
* this for Fluid Containers.
*
* @param item
* @param coolant
*/
public static void addCoolant(final Item item, final int metadata, final FluidStack coolant) {

View file

@ -28,7 +28,6 @@ public interface IPowerReceptor {
* engines to eventually explode.
*
* @param side
* @return
*/
PowerHandler.PowerReceiver getPowerReceiver(ForgeDirection side);

View file

@ -95,7 +95,6 @@ public final class PowerHandler {
* @param powerHandler the PowerHandler requesting the perdition update
* @param current the current stored energy
* @param ticksPassed ticks since the last time this function was called
* @return
*/
public double applyPerdition(PowerHandler powerHandler, double current, long ticksPassed) {
double newPower = current - powerLoss * ticksPassed;
@ -425,8 +424,6 @@ public final class PowerHandler {
/**
* The amount of power that this PowerHandler currently needs.
*
* @return
*/
public double powerRequest() {
update();

View file

@ -25,11 +25,14 @@ public interface IAssemblyRecipeManager {
/**
* Add an Assembly Table recipe.
*
* @param input Object... containing either an ItemStack, or a paired string
* and integer(ex: "dyeBlue", 1)
* @param energy MJ cost to produce
* @param output resulting ItemStack
*
* @param input
* Object... containing either an ItemStack, or a paired string
* and integer(ex: "dyeBlue", 1)
* @param energyCost
* MJ cost to produce
* @param output
* resulting ItemStack
*/
void addRecipe(double energyCost, ItemStack output, Object... input);

View file

@ -9,6 +9,7 @@
package buildcraft.api.transport;
import net.minecraft.item.ItemStack;
import net.minecraftforge.common.util.ForgeDirection;
public interface IPipeTile {
@ -34,8 +35,8 @@ public interface IPipeTile {
/**
* True if the pipe is connected to the block/pipe in the specific direction
*
* @param wire
*
* @param with
* @return true if connect
*/
boolean isPipeConnected(ForgeDirection with);

View file

@ -32,7 +32,6 @@ public interface ITransactor {
* @param filter
* @param orientation
* @param doRemove
* @return
*/
ItemStack remove(IStackFilter filter, ForgeDirection orientation, boolean doRemove);
}

View file

@ -79,10 +79,11 @@ public final class InvUtils {
/**
* Attempts to move a single item from one inventory to another.
*
*
* @param source
* @param dest
* @param filer an IStackFilter to match against
* @param filter
* an IStackFilter to match against
* @return null if nothing was moved, the stack moved otherwise
*/
public static ItemStack moveOneItem(IInventory source, ForgeDirection output, IInventory dest, ForgeDirection intput, IStackFilter filter) {

View file

@ -63,7 +63,6 @@ public final class MatrixTranformations {
* Clones both dimensions of a float[][]
*
* @param source the float[][] to deepClone
* @return
*/
public static float[][] deepClone(float[][] source) {
float[][] target = source.clone();

View file

@ -165,8 +165,6 @@ public abstract class Pipe<T extends PipeTransport> implements IDropControlInven
* Should return the textureindex used by the Pipe Item Renderer, as this is
* done client-side the default implementation might not work if your
* getTextureIndex(Orienations.Unknown) has logic. Then override this
*
* @return
*/
public int getIconIndexForItem() {
return getIconIndex(ForgeDirection.UNKNOWN);

View file

@ -270,7 +270,6 @@ public class PacketHandlerTransport extends BuildCraftChannelHandler {
* @param x
* @param y
* @param z
* @return
*/
private TileGenericPipe getPipe(World world, int x, int y, int z) {
if (!world.blockExists(x, y, z)) {