mirror of
https://github.com/Thorfusion/Mekanism-Community-Edition.git
synced 2026-11-22 04:52:25 +00:00
Fix some JavaDoc warnings
This commit is contained in:
1 parent
babbe59cab
commit
9fc52c6016
24 files changed
+50
-69
No files matched your search
@@ -299,10 +299,9 @@ public class Coord4D
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether or not the defined side of this Coord4D is visible.
|
||||
* @param side - side to check
|
||||
* @param world - world this Coord4D is in
|
||||
* @return
|
||||
* @return Whether or not the defined side of this Coord4D is visible.
|
||||
*/
|
||||
public boolean sideVisible(EnumFacing side, IBlockAccess world)
|
||||
{
|
||||
|
||||
@@ -102,7 +102,7 @@ public class Pos3D extends Vec3d
|
||||
|
||||
/**
|
||||
* Creates a new Pos3D from the motion of an entity.
|
||||
* @param entity
|
||||
* @param entity Entitiy to get the motion from
|
||||
* @return Pos3D representing the motion of the given entity
|
||||
*/
|
||||
public static Pos3D fromMotion(Entity entity)
|
||||
|
||||
@@ -142,7 +142,7 @@ public class Gas
|
||||
|
||||
/**
|
||||
* Sets this gas's icon.
|
||||
* @param i - IIcon to associate with this Gas
|
||||
* @param map - IIcon to associate with this Gas
|
||||
* @return this Gas object
|
||||
*/
|
||||
public Gas registerIcon(TextureMap map)
|
||||
|
||||
@@ -147,7 +147,7 @@ public class GasTank
|
||||
|
||||
/**
|
||||
* Gets the amount of gas needed by this GasTank.
|
||||
* @return
|
||||
* @return Amount of gas needed
|
||||
*/
|
||||
public int getNeeded()
|
||||
{
|
||||
|
||||
@@ -11,15 +11,14 @@ public interface IGasItem
|
||||
{
|
||||
/**
|
||||
* Gets the rate of transfer this item can handle.
|
||||
* @return
|
||||
* @return The transfer rate of what the item can handle.
|
||||
*/
|
||||
int getRate(ItemStack itemstack);
|
||||
|
||||
/**
|
||||
* Adds a defined amount of a certain gas to an item.
|
||||
* @param itemstack - the itemstack to add gas to
|
||||
* @param type - the type of gas to add
|
||||
* @param amount - the amount of gas to add
|
||||
* @param stack - the type and amount of gas to add
|
||||
* @return the gas that was accepted by the item
|
||||
*/
|
||||
int addGas(ItemStack itemstack, GasStack stack);
|
||||
@@ -27,7 +26,6 @@ public interface IGasItem
|
||||
/**
|
||||
* Removes the defined amount of a certain gas from the item.
|
||||
* @param itemstack - the itemstack to remove gas from
|
||||
* @param type - the type of gas to remove
|
||||
* @param amount - the amount of gas to remove
|
||||
* @return the gas that was removed by the item
|
||||
*/
|
||||
@@ -51,24 +49,21 @@ public interface IGasItem
|
||||
|
||||
/**
|
||||
* Get the gas of a declared type.
|
||||
* @param type - type of gas
|
||||
* @param data - ItemStack parameter if necessary
|
||||
* @param itemstack - ItemStack parameter
|
||||
* @return gas stored
|
||||
*/
|
||||
GasStack getGas(ItemStack itemstack);
|
||||
|
||||
/**
|
||||
* Set the gas of a declared type to a new amount;
|
||||
* @param type - type of gas
|
||||
* @param data - ItemStack parameter if necessary
|
||||
* @param amount - amount to store
|
||||
* @param itemstack - ItemStack parameter
|
||||
* @param stack - the type and amount of gas to add
|
||||
*/
|
||||
void setGas(ItemStack itemstack, GasStack stack);
|
||||
|
||||
/**
|
||||
* Gets the maximum amount of gas this tile entity can store.
|
||||
* @param type - type of gas
|
||||
* @param data - ItemStack parameter if necessary
|
||||
* @param itemstack - ItemStack parameter
|
||||
* @return maximum gas
|
||||
*/
|
||||
int getMaxGas(ItemStack itemstack);
|
||||
|
||||
@@ -20,7 +20,7 @@ public class InfuseRegistry
|
||||
|
||||
/**
|
||||
* Registers an InfuseType into the registry. Call this in PreInit!
|
||||
* @param infuse
|
||||
* @param infuse InfuseType to register
|
||||
*/
|
||||
public static void registerInfuseType(InfuseType infuse)
|
||||
{
|
||||
|
||||
@@ -307,7 +307,7 @@ public abstract class DynamicNetwork<A, N extends DynamicNetwork<A, N>> implemen
|
||||
|
||||
/**
|
||||
* Override this if things can have variable capacity along the network.
|
||||
* @return An 'average' value of capacity. Calculate it how you will.
|
||||
* An 'average' value of capacity. Calculate it how you will.
|
||||
*/
|
||||
protected synchronized void updateMeanCapacity()
|
||||
{
|
||||
|
||||
@@ -15,8 +15,8 @@ public abstract class MekKeyHandler
|
||||
/**
|
||||
* Pass an array of keybindings and a repeat flag for each one
|
||||
*
|
||||
* @param bindings
|
||||
* @param rep
|
||||
* @param bindings Bindings to set
|
||||
* @param rep Repeat flags for bindings
|
||||
*/
|
||||
public MekKeyHandler(KeyBinding[] bindings, boolean[] rep)
|
||||
{
|
||||
@@ -30,7 +30,7 @@ public abstract class MekKeyHandler
|
||||
* Register the keys into the system. You will do your own keyboard
|
||||
* management elsewhere. No events will fire if you use this method
|
||||
*
|
||||
* @param bindings
|
||||
* @param bindings Bindings to set
|
||||
*/
|
||||
public MekKeyHandler(KeyBinding[] bindings)
|
||||
{
|
||||
@@ -78,4 +78,4 @@ public abstract class MekKeyHandler
|
||||
public abstract void keyDown(KeyBinding kb, boolean isRepeat);
|
||||
|
||||
public abstract void keyUp(KeyBinding kb);
|
||||
}
|
||||
}
|
||||
@@ -30,7 +30,7 @@ public class FluidSlot
|
||||
|
||||
/**
|
||||
* Sets the fluid to a new amount.
|
||||
* @param fluid - amount to store
|
||||
* @param amount - amount to store
|
||||
*/
|
||||
public void setFluid(int amount)
|
||||
{
|
||||
|
||||
@@ -96,7 +96,7 @@ public class MekanismItems
|
||||
|
||||
/**
|
||||
* Adds and registers all items.
|
||||
* @param registry
|
||||
* @param registry Forge registry to add the items to
|
||||
*/
|
||||
public static void registerItems(IForgeRegistry<Item> registry)
|
||||
{
|
||||
|
||||
@@ -40,11 +40,8 @@ public class Version
|
||||
}
|
||||
|
||||
/**
|
||||
* 1: greater than
|
||||
* 0: equal to
|
||||
* -1: less than
|
||||
* @param version
|
||||
* @return
|
||||
* @param version Version to check against
|
||||
* @return 1: greater than, 0: equal to, -1: less than
|
||||
*/
|
||||
public byte comparedState(Version version)
|
||||
{
|
||||
|
||||
@@ -25,7 +25,7 @@ public interface ISideConfiguration
|
||||
|
||||
/**
|
||||
* Gets this machine's ejector.
|
||||
* @return
|
||||
* @return this machine's ejector
|
||||
*/
|
||||
TileComponentEjector getEjector();
|
||||
}
|
||||
@@ -11,7 +11,7 @@ public interface ISustainedTank
|
||||
{
|
||||
/**
|
||||
* Sets the tank tag list to a new value.
|
||||
* @param nbtTags - NBTTagList value to set
|
||||
* @param fluidStack - Fluidstack to apply to
|
||||
* @param data - ItemStack parameter if using on item
|
||||
*/
|
||||
void setFluidStack(FluidStack fluidStack, Object... data);
|
||||
|
||||
@@ -13,14 +13,14 @@ public interface ITileNetwork
|
||||
{
|
||||
/**
|
||||
* Receive and manage a packet's data.
|
||||
* @param dataStream
|
||||
* @param dataStream Datastream to parse
|
||||
*/
|
||||
void handlePacketData(ByteBuf dataStream) throws Exception;
|
||||
|
||||
/**
|
||||
* Gets an ArrayList of data this tile entity keeps synchronized with the client.
|
||||
* @param data - list of data
|
||||
* @return ArrayList
|
||||
* @return ArrayList of network data
|
||||
*/
|
||||
ArrayList<Object> getNetworkedData(ArrayList<Object> data);
|
||||
}
|
||||
@@ -33,7 +33,7 @@ public abstract class UpdateProtocol<T extends SynchronizedData<T>>
|
||||
|
||||
/**
|
||||
* Recursively loops through each node connected to the given TileEntity.
|
||||
* @param tile - the TileEntity to loop over
|
||||
* @param coord - the TileEntity coords to loop over
|
||||
*/
|
||||
public void loopThrough(Coord4D coord)
|
||||
{
|
||||
@@ -271,11 +271,10 @@ public abstract class UpdateProtocol<T extends SynchronizedData<T>>
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether or not the block at the specified location is an air block.
|
||||
* @param x - x coordinate
|
||||
* @param y - y coordinate
|
||||
* @param z - z coordinate
|
||||
* @return
|
||||
* @return Whether or not the block at the specified location is an air block.
|
||||
*/
|
||||
protected boolean isAir(int x, int y, int z)
|
||||
{
|
||||
@@ -288,11 +287,10 @@ public abstract class UpdateProtocol<T extends SynchronizedData<T>>
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether or not the block at the specified location is a viable node for a multiblock structure.
|
||||
* @param x - x coordinate
|
||||
* @param y - y coordinate
|
||||
* @param z - z coordinate
|
||||
* @return
|
||||
* @return Whether or not the block at the specified location is a viable node for a multiblock structure.
|
||||
*/
|
||||
public boolean isViableNode(int x, int y, int z)
|
||||
{
|
||||
@@ -315,9 +313,8 @@ public abstract class UpdateProtocol<T extends SynchronizedData<T>>
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether or not the block at the specified location is a viable node for a multiblock structure.
|
||||
* @param pos - coordinates
|
||||
* @return
|
||||
* @return Whether or not the block at the specified location is a viable node for a multiblock structure.
|
||||
*/
|
||||
public boolean isViableNode(BlockPos pos)
|
||||
{
|
||||
@@ -345,13 +342,13 @@ public abstract class UpdateProtocol<T extends SynchronizedData<T>>
|
||||
}
|
||||
|
||||
/**
|
||||
* If the block at the specified location is on the minimum of all angles of this multiblock structure, and the one to use for the
|
||||
* actual calculation.
|
||||
*
|
||||
* @param obj - location to check
|
||||
* @param xmin - minimum x value
|
||||
* @param ymin - minimum y value
|
||||
* @param zmin - minimum z value
|
||||
* @return
|
||||
* @return If the block at the specified location is on the minimum of all angles of this multiblock structure, and the one to use for the
|
||||
* actual calculation.
|
||||
*/
|
||||
private boolean isCorrectCorner(Coord4D obj, int xmin, int ymin, int zmin)
|
||||
{
|
||||
@@ -364,7 +361,6 @@ public abstract class UpdateProtocol<T extends SynchronizedData<T>>
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether or not the block at the specified location is considered a frame on the multiblock structure.
|
||||
* @param obj - location to check
|
||||
* @param xmin - minimum x value
|
||||
* @param xmax - maximum x value
|
||||
@@ -372,7 +368,7 @@ public abstract class UpdateProtocol<T extends SynchronizedData<T>>
|
||||
* @param ymax - maximum y value
|
||||
* @param zmin - minimum z value
|
||||
* @param zmax - maximum z value
|
||||
* @return
|
||||
* @return Whether or not the block at the specified location is considered a frame on the multiblock structure.
|
||||
*/
|
||||
private boolean isFrame(Coord4D obj, int xmin, int xmax, int ymin, int ymax, int zmin, int zmax)
|
||||
{
|
||||
@@ -407,11 +403,10 @@ public abstract class UpdateProtocol<T extends SynchronizedData<T>>
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether or not the block at the specified location serves as a frame for a multiblock structure.
|
||||
* @param x - x coordinate
|
||||
* @param y - y coordinate
|
||||
* @param z - z coordinate
|
||||
* @return
|
||||
* @return Whether or not the block at the specified location serves as a frame for a multiblock structure.
|
||||
*/
|
||||
protected abstract boolean isValidFrame(int x, int y, int z);
|
||||
|
||||
|
||||
@@ -67,8 +67,7 @@ public class ChemicalPairInput extends MachineInput<ChemicalPairInput>
|
||||
}
|
||||
|
||||
/**
|
||||
* If this is a valid ChemicalPair
|
||||
* @return
|
||||
* @return True if this is a valid ChemicalPair
|
||||
*/
|
||||
@Override
|
||||
public boolean isValid()
|
||||
|
||||
@@ -20,8 +20,9 @@ public abstract class MachineInput<INPUT extends MachineInput<INPUT>>
|
||||
* This should return true if the input matches this one,
|
||||
* IGNORING AMOUNTS.
|
||||
* Allows usage of HashMap optimisation to get recipes.
|
||||
* @param other
|
||||
* @return
|
||||
*
|
||||
* @param other The other input to check
|
||||
* @return True if input matches this one, IGNORING AMOUNTS!
|
||||
*/
|
||||
public abstract boolean testEquality(INPUT other);
|
||||
|
||||
|
||||
@@ -38,8 +38,7 @@ public class ChemicalPairOutput extends MachineOutput<ChemicalPairOutput>
|
||||
}
|
||||
|
||||
/**
|
||||
* If this is a valid ChemicalPair
|
||||
* @return
|
||||
* @return True if this is a valid ChemicalPair
|
||||
*/
|
||||
public boolean isValid()
|
||||
{
|
||||
|
||||
@@ -302,11 +302,7 @@ public class TileEntityTeleporter extends TileEntityElectricBlock implements ICo
|
||||
}
|
||||
|
||||
/**
|
||||
* 1: yes
|
||||
* 2: no frame
|
||||
* 3: no link found
|
||||
* 4: not enough electricity
|
||||
* @return
|
||||
* @return 1: yes, 2: no frame, 3: no link found, 4: not enough electricity
|
||||
*/
|
||||
public byte canTeleport()
|
||||
{
|
||||
|
||||
@@ -39,7 +39,7 @@ public final class CableUtils
|
||||
/**
|
||||
* Gets the adjacent connections to a TileEntity, from a subset of its sides.
|
||||
* @param tileEntity - center TileEntity
|
||||
* @param sides - set of sides to check
|
||||
* @param sideFunction - set of sides to check
|
||||
* @return boolean[] of adjacent connections
|
||||
*/
|
||||
public static boolean[] getConnections(TileEntity tileEntity, Function<EnumFacing, Boolean> sideFunction)
|
||||
|
||||
@@ -374,8 +374,8 @@ public final class MekanismUtils
|
||||
|
||||
/**
|
||||
* Checks if a machine is in it's active state.
|
||||
* @param world
|
||||
* @param pos
|
||||
* @param world World of the machine to check
|
||||
* @param pos The position of the machine
|
||||
* @return if machine is active
|
||||
*/
|
||||
public static boolean isActive(IBlockAccess world, BlockPos pos)
|
||||
@@ -395,7 +395,7 @@ public final class MekanismUtils
|
||||
|
||||
/**
|
||||
* Gets the left side of a certain orientation.
|
||||
* @param orientation
|
||||
* @param orientation Current orientation of the machine
|
||||
* @return left side
|
||||
*/
|
||||
public static EnumFacing getLeft(EnumFacing orientation)
|
||||
@@ -405,7 +405,7 @@ public final class MekanismUtils
|
||||
|
||||
/**
|
||||
* Gets the right side of a certain orientation.
|
||||
* @param orientation
|
||||
* @param orientation Current orientation of the machine
|
||||
* @return right side
|
||||
*/
|
||||
public static EnumFacing getRight(EnumFacing orientation)
|
||||
@@ -415,7 +415,7 @@ public final class MekanismUtils
|
||||
|
||||
/**
|
||||
* Gets the opposite side of a certain orientation.
|
||||
* @param orientation
|
||||
* @param orientation Current orientation of the machine
|
||||
* @return opposite side
|
||||
*/
|
||||
public static EnumFacing getBack(EnumFacing orientation)
|
||||
@@ -811,7 +811,7 @@ public final class MekanismUtils
|
||||
/**
|
||||
* Updates a block's light value and marks it for a render update.
|
||||
* @param world - world the block is in
|
||||
* @param pos
|
||||
* @param pos Position of the block
|
||||
*/
|
||||
public static void updateBlock(World world, BlockPos pos)
|
||||
{
|
||||
|
||||
@@ -168,7 +168,7 @@ public class TileEntityBioGenerator extends TileEntityGenerator implements IFlui
|
||||
/**
|
||||
* Gets the scaled fuel level for the GUI.
|
||||
* @param i - multiplier
|
||||
* @return
|
||||
* @return Scaled fuel level
|
||||
*/
|
||||
public int getScaledFuelLevel(int i)
|
||||
{
|
||||
@@ -325,4 +325,4 @@ public class TileEntityBioGenerator extends TileEntityGenerator implements IFlui
|
||||
|
||||
return super.getCapability(capability, side);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -199,7 +199,7 @@ public class TileEntityGasGenerator extends TileEntityGenerator implements IGasH
|
||||
/**
|
||||
* Gets the scaled gas level for the GUI.
|
||||
* @param i - multiplier
|
||||
* @return
|
||||
* @return Scaled gas level
|
||||
*/
|
||||
public int getScaledGasLevel(int i)
|
||||
{
|
||||
|
||||
@@ -226,7 +226,7 @@ public class TileEntityHeatGenerator extends TileEntityGenerator implements IFlu
|
||||
/**
|
||||
* Gets the scaled fuel level for the GUI.
|
||||
* @param i - multiplier
|
||||
* @return
|
||||
* @return Scaled fuel level
|
||||
*/
|
||||
public int getScaledFuelLevel(int i)
|
||||
{
|
||||
|
||||
Reference in new issue
Block a user