diff --git a/ee3_client/ee3/client/gui/GuiCalcinator.java b/ee3_client/ee3/client/gui/GuiCalcinator.java index 7b2944f4..76a860fe 100644 --- a/ee3_client/ee3/client/gui/GuiCalcinator.java +++ b/ee3_client/ee3/client/gui/GuiCalcinator.java @@ -14,7 +14,15 @@ import net.minecraft.src.InventoryPlayer; import net.minecraft.src.StatCollector; import net.minecraft.src.TileEntityFurnace; -@SideOnly(Side.CLIENT) +/** + * GuiCalcinator + * + * Calcinator Gui class + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class GuiCalcinator extends GuiContainer { private TileCalcinator calcinator; diff --git a/ee3_client/ee3/client/gui/GuiPortableCrafting.java b/ee3_client/ee3/client/gui/GuiPortableCrafting.java index 83a3ef11..45aa8cb8 100644 --- a/ee3_client/ee3/client/gui/GuiPortableCrafting.java +++ b/ee3_client/ee3/client/gui/GuiPortableCrafting.java @@ -11,7 +11,15 @@ import net.minecraft.src.GuiContainer; import net.minecraft.src.StatCollector; import net.minecraft.src.World; -@SideOnly(Side.CLIENT) +/** + * GuiPortableCrafting + * + * Portable Crafting Gui class + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class GuiPortableCrafting extends GuiContainer { public GuiPortableCrafting(EntityPlayer player, World world, int x, int y, int z) { diff --git a/ee3_client/ee3/client/render/ModelCalcinator.java b/ee3_client/ee3/client/render/ModelCalcinator.java index 0d3cec8f..02efd95f 100644 --- a/ee3_client/ee3/client/render/ModelCalcinator.java +++ b/ee3_client/ee3/client/render/ModelCalcinator.java @@ -8,6 +8,15 @@ import net.minecraft.src.ModelBase; import net.minecraft.src.ModelRenderer; import net.minecraftforge.client.ForgeHooksClient; +/** + * ModelCalcinator + * + * Model for the Calcinator + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class ModelCalcinator extends ModelBase { private static final int TEXTURE_HEIGHT = 128; diff --git a/ee3_client/ee3/client/render/RenderCalcinator.java b/ee3_client/ee3/client/render/RenderCalcinator.java index c415b2c7..30814cbc 100644 --- a/ee3_client/ee3/client/render/RenderCalcinator.java +++ b/ee3_client/ee3/client/render/RenderCalcinator.java @@ -9,6 +9,15 @@ import net.minecraft.src.ModelRenderer; import net.minecraft.src.TileEntity; import net.minecraft.src.TileEntitySpecialRenderer; +/** + * RenderCalcinator + * + * Renders the Calcinator in game as a TESR (Tile Entity Special Render) + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class RenderCalcinator extends TileEntitySpecialRenderer { static final float scale = (float) (1.0 / 16.0); diff --git a/ee3_client/ee3/client/render/RenderItemCalcinator.java b/ee3_client/ee3/client/render/RenderItemCalcinator.java index 72062a06..4f8f67e1 100644 --- a/ee3_client/ee3/client/render/RenderItemCalcinator.java +++ b/ee3_client/ee3/client/render/RenderItemCalcinator.java @@ -8,6 +8,15 @@ import net.minecraft.src.Tessellator; import net.minecraftforge.client.ForgeHooksClient; import net.minecraftforge.client.IItemRenderer; +/** + * RenderItemCalcinator + * + * Renders the Calcinator in game as an item (in hand, on the ground, and in inventory) + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class RenderItemCalcinator implements IItemRenderer { private ModelCalcinator calcinatorModel; diff --git a/ee3_client/ee3/client/render/TextureRedWaterFX.java b/ee3_client/ee3/client/render/TextureRedWaterFX.java index f0eab03d..98d4ade7 100644 --- a/ee3_client/ee3/client/render/TextureRedWaterFX.java +++ b/ee3_client/ee3/client/render/TextureRedWaterFX.java @@ -8,6 +8,15 @@ import cpw.mods.fml.client.FMLTextureFX; import ee3.common.block.ModBlocks; import ee3.common.lib.Reference; +/** + * TextureRedWaterFX + * + * TextureFX for still Red Water + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class TextureRedWaterFX extends FMLTextureFX { protected float[] red = new float[256]; diff --git a/ee3_client/ee3/client/render/TextureRedWaterFlowFX.java b/ee3_client/ee3/client/render/TextureRedWaterFlowFX.java index f593b240..5a70ad8e 100644 --- a/ee3_client/ee3/client/render/TextureRedWaterFlowFX.java +++ b/ee3_client/ee3/client/render/TextureRedWaterFlowFX.java @@ -8,6 +8,15 @@ import cpw.mods.fml.client.FMLTextureFX; import ee3.common.block.ModBlocks; import ee3.common.lib.Reference; +/** + * TextureRedWaterFlowFX + * + * TextureFX for flowing Red Water + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class TextureRedWaterFlowFX extends FMLTextureFX { protected float[] red = new float[256]; diff --git a/ee3_common/ee3/common/block/BlockRedWaterFlowing.java b/ee3_common/ee3/common/block/BlockRedWaterFlowing.java index ba158c94..af9f51f7 100644 --- a/ee3_common/ee3/common/block/BlockRedWaterFlowing.java +++ b/ee3_common/ee3/common/block/BlockRedWaterFlowing.java @@ -5,6 +5,15 @@ import net.minecraft.src.BlockFlowing; import net.minecraft.src.CreativeTabs; import net.minecraft.src.Material; +/** + * BlockRedWaterFlowing + * + * Class for the flowing version of Red Water + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class BlockRedWaterFlowing extends BlockFlowing { protected BlockRedWaterFlowing(int id, Material material) { diff --git a/ee3_common/ee3/common/block/BlockRedWaterStill.java b/ee3_common/ee3/common/block/BlockRedWaterStill.java index c13c044a..2677f6bd 100644 --- a/ee3_common/ee3/common/block/BlockRedWaterStill.java +++ b/ee3_common/ee3/common/block/BlockRedWaterStill.java @@ -5,6 +5,15 @@ import net.minecraft.src.BlockStationary; import net.minecraft.src.CreativeTabs; import net.minecraft.src.Material; +/** + * BlockRedWaterFlowing + * + * Class for the still version of Red Water + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class BlockRedWaterStill extends BlockStationary { protected BlockRedWaterStill(int id, Material material) { diff --git a/ee3_common/ee3/common/block/ModBlocks.java b/ee3_common/ee3/common/block/ModBlocks.java index 5d8b6611..551a924d 100644 --- a/ee3_common/ee3/common/block/ModBlocks.java +++ b/ee3_common/ee3/common/block/ModBlocks.java @@ -9,6 +9,15 @@ import net.minecraft.src.Item; import net.minecraft.src.ItemStack; import net.minecraft.src.Material; +/** + * ModBlocks + * + * Class containing all the EE3 custom blocks + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class ModBlocks { /* Block name constants */ diff --git a/ee3_common/ee3/common/container/ContainerCalcinator.java b/ee3_common/ee3/common/container/ContainerCalcinator.java index 2b61e9af..c5c8b4b2 100644 --- a/ee3_common/ee3/common/container/ContainerCalcinator.java +++ b/ee3_common/ee3/common/container/ContainerCalcinator.java @@ -9,6 +9,15 @@ import net.minecraft.src.ItemStack; import net.minecraft.src.Slot; import net.minecraft.src.TileEntityFurnace; +/** + * ContainerCalcinator + * + * The container class for the Calcinator + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class ContainerCalcinator extends Container { private TileCalcinator calcinator; diff --git a/ee3_common/ee3/common/container/ContainerPortableCrafting.java b/ee3_common/ee3/common/container/ContainerPortableCrafting.java index b50cabc2..dd3beb01 100644 --- a/ee3_common/ee3/common/container/ContainerPortableCrafting.java +++ b/ee3_common/ee3/common/container/ContainerPortableCrafting.java @@ -5,6 +5,15 @@ import net.minecraft.src.EntityPlayer; import net.minecraft.src.InventoryPlayer; import net.minecraft.src.World; +/** + * ContainerPortableCrafting + * + * Container class for the portable crafting interface + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class ContainerPortableCrafting extends ContainerWorkbench { public ContainerPortableCrafting(InventoryPlayer inventoryPlayer, World world, int x, int y, int z) { diff --git a/ee3_common/ee3/common/core/handlers/EntityLivingHandler.java b/ee3_common/ee3/common/core/handlers/EntityLivingHandler.java index 261131ef..ede65e9e 100644 --- a/ee3_common/ee3/common/core/handlers/EntityLivingHandler.java +++ b/ee3_common/ee3/common/core/handlers/EntityLivingHandler.java @@ -11,6 +11,15 @@ import net.minecraftforge.event.ForgeSubscribe; import net.minecraftforge.event.entity.living.LivingDeathEvent; import net.minecraftforge.event.entity.living.LivingEvent.LivingUpdateEvent; +/** + * EntityLivingHandler + * + * Class containing all EE3 custom event related logic for EntityLiving events + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class EntityLivingHandler { @ForgeSubscribe diff --git a/ee3_common/ee3/common/core/handlers/EquivalencyHandler.java b/ee3_common/ee3/common/core/handlers/EquivalencyHandler.java index 717ee0d4..cd02a3c6 100644 --- a/ee3_common/ee3/common/core/handlers/EquivalencyHandler.java +++ b/ee3_common/ee3/common/core/handlers/EquivalencyHandler.java @@ -5,6 +5,15 @@ import java.util.ArrayList; import ee3.common.core.helper.GeneralHelper; import net.minecraft.src.ItemStack; +/** + * EquivalencyHandler + * + * Class to handle all the equivalency relationships between items/etc + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class EquivalencyHandler { private static final EquivalencyHandler instance = new EquivalencyHandler(); diff --git a/ee3_common/ee3/common/core/handlers/FuelHandler.java b/ee3_common/ee3/common/core/handlers/FuelHandler.java index 5b63302d..76b46261 100644 --- a/ee3_common/ee3/common/core/handlers/FuelHandler.java +++ b/ee3_common/ee3/common/core/handlers/FuelHandler.java @@ -3,6 +3,15 @@ package ee3.common.core.handlers; import net.minecraft.src.ItemStack; import cpw.mods.fml.common.IFuelHandler; +/** + * FuelHandler + * + * Class for querying and returning fuel values for items + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class FuelHandler implements IFuelHandler { @Override diff --git a/ee3_common/ee3/common/core/handlers/PlayerDestroyItemHandler.java b/ee3_common/ee3/common/core/handlers/PlayerDestroyItemHandler.java index 6ca13f7f..8b9f7fb2 100644 --- a/ee3_common/ee3/common/core/handlers/PlayerDestroyItemHandler.java +++ b/ee3_common/ee3/common/core/handlers/PlayerDestroyItemHandler.java @@ -3,6 +3,15 @@ package ee3.common.core.handlers; import net.minecraftforge.event.ForgeSubscribe; import net.minecraftforge.event.entity.player.PlayerDestroyItemEvent; +/** + * PlayerDestroyItemHandler + * + * Class containing all EE3 custom event related logic for PlayerDestroyItem events + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class PlayerDestroyItemHandler { @ForgeSubscribe diff --git a/ee3_common/ee3/common/core/handlers/VersionCheckTickHandler.java b/ee3_common/ee3/common/core/handlers/VersionCheckTickHandler.java index 5a12febf..3d62cc3a 100644 --- a/ee3_common/ee3/common/core/handlers/VersionCheckTickHandler.java +++ b/ee3_common/ee3/common/core/handlers/VersionCheckTickHandler.java @@ -10,6 +10,15 @@ import ee3.common.lib.Colours; import ee3.common.lib.ConfigurationSettings; import ee3.common.lib.Reference; +/** + * VersionCheckTickHandler + * + * Class for notifying the player on their client when they get in game the outcome of the remote version check + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class VersionCheckTickHandler implements ITickHandler { private static boolean initialized = false; diff --git a/ee3_common/ee3/common/core/helper/GeneralHelper.java b/ee3_common/ee3/common/core/helper/GeneralHelper.java index 0c8533ff..b28b0ab1 100644 --- a/ee3_common/ee3/common/core/helper/GeneralHelper.java +++ b/ee3_common/ee3/common/core/helper/GeneralHelper.java @@ -6,6 +6,15 @@ import net.minecraft.src.Block; import net.minecraft.src.Item; import net.minecraft.src.ItemStack; +/** + * GeneralHelper + * + * General helper methods for EE3 + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class GeneralHelper { public static ItemStack convertObjectToItemStack(Object obj) { diff --git a/ee3_common/ee3/common/core/helper/ItemDropHelper.java b/ee3_common/ee3/common/core/helper/ItemDropHelper.java index 2707a626..1ce88937 100644 --- a/ee3_common/ee3/common/core/helper/ItemDropHelper.java +++ b/ee3_common/ee3/common/core/helper/ItemDropHelper.java @@ -5,6 +5,15 @@ import net.minecraft.src.EntityAgeable; import net.minecraft.src.EntityLiving; import net.minecraft.src.EntityPlayer; +/** + * ItemDropHelper + * + * Helper methods for dropping items in game + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class ItemDropHelper { private static double rand; diff --git a/ee3_common/ee3/common/core/helper/LogHelper.java b/ee3_common/ee3/common/core/helper/LogHelper.java index 7a33727f..a6432674 100644 --- a/ee3_common/ee3/common/core/helper/LogHelper.java +++ b/ee3_common/ee3/common/core/helper/LogHelper.java @@ -8,6 +8,15 @@ import cpw.mods.fml.common.FMLLog; import ee3.common.EquivalentExchange3; import ee3.common.lib.Reference; +/** + * LogHelper + * + * Helper methods for logging to the EE3 logger + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class LogHelper { private static Logger eeLogger = Logger.getLogger(Reference.MOD_NAME); diff --git a/ee3_common/ee3/common/core/helper/NBTHelper.java b/ee3_common/ee3/common/core/helper/NBTHelper.java index 7f47b74c..e03c938e 100644 --- a/ee3_common/ee3/common/core/helper/NBTHelper.java +++ b/ee3_common/ee3/common/core/helper/NBTHelper.java @@ -3,6 +3,15 @@ package ee3.common.core.helper; import net.minecraft.src.ItemStack; import net.minecraft.src.NBTTagCompound; +/** + * NBTHelper + * + * Helper methods for manipulating NBT data on ItemStacks + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class NBTHelper { /** diff --git a/ee3_common/ee3/common/core/helper/QualityHelper.java b/ee3_common/ee3/common/core/helper/QualityHelper.java index b14df137..e668cc9d 100644 --- a/ee3_common/ee3/common/core/helper/QualityHelper.java +++ b/ee3_common/ee3/common/core/helper/QualityHelper.java @@ -2,20 +2,17 @@ package ee3.common.core.helper; import net.minecraft.src.ItemStack; +/** + * QualityHelper + * + * Helper methods for determining the quality tier of items + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class QualityHelper { - /* - * Legend for the dust table quality lookup, comparison is based off of quality tiers - * - * Item Quality - * |_0_|_1_|_2_|_3_|_4_|_5_| - * Fuel 0 | 0 | 0 | 0 | 1 | 1 | 1 | - * Quality 1 | 0 | 1 | 1 | 1 | 2 | 2 | - * 2 | 0 | 1 | 2 | 2 | 2 | 2 | - * 3 | 1 | 1 | 2 | 3 | 3 | 3 | - * 4 | 1 | 2 | 2 | 3 | 4 | 4 | - * 5 | 1 | 2 | 2 | 3 | 4 | 5 | - */ private static int[][] dustTable = { {0, 0, 0, 1, 1, 1}, {0, 1, 1, 1, 2, 2}, diff --git a/ee3_common/ee3/common/core/helper/RecipeHelper.java b/ee3_common/ee3/common/core/helper/RecipeHelper.java index 48321756..b4261d9d 100644 --- a/ee3_common/ee3/common/core/helper/RecipeHelper.java +++ b/ee3_common/ee3/common/core/helper/RecipeHelper.java @@ -8,6 +8,15 @@ import net.minecraft.src.Item; import net.minecraft.src.ItemStack; import cpw.mods.fml.common.registry.GameRegistry; +/** + * RecipeHelper + * + * Helper methods for adding recipes + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class RecipeHelper { public static void addRecipe(ItemStack output, Object... input) { diff --git a/ee3_common/ee3/common/core/helper/RedWaterHelper.java b/ee3_common/ee3/common/core/helper/RedWaterHelper.java index 9e70dba7..e35a37f2 100644 --- a/ee3_common/ee3/common/core/helper/RedWaterHelper.java +++ b/ee3_common/ee3/common/core/helper/RedWaterHelper.java @@ -8,6 +8,15 @@ import net.minecraft.src.EntityLiving; import net.minecraft.src.MathHelper; import net.minecraft.src.World; +/** + * RedWaterHelper + * + * Helper methods for Red Water related effects + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class RedWaterHelper { public static boolean handleRedWaterDetection(EntityLiving entity) { diff --git a/ee3_common/ee3/common/core/helper/TransmutationHelper.java b/ee3_common/ee3/common/core/helper/TransmutationHelper.java index cb5f0f20..1de1667e 100644 --- a/ee3_common/ee3/common/core/helper/TransmutationHelper.java +++ b/ee3_common/ee3/common/core/helper/TransmutationHelper.java @@ -13,6 +13,15 @@ import net.minecraft.src.ItemStack; import net.minecraft.src.Material; import net.minecraft.src.World; +/** + * TransmutationHelper + * + * Helper methods for transmutation related things + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class TransmutationHelper { public static boolean transmuteInWorld(World world, EntityPlayer player, ItemStack stack, int x, int y, int z) { diff --git a/ee3_common/ee3/common/emc/EMCEntry.java b/ee3_common/ee3/common/emc/EMCEntry.java index db21da1e..6a3d5fbe 100644 --- a/ee3_common/ee3/common/emc/EMCEntry.java +++ b/ee3_common/ee3/common/emc/EMCEntry.java @@ -4,6 +4,15 @@ import java.util.Collections; import java.util.HashMap; import java.util.Map; +/** + * EMCEntry + * + * Holds the breakdown of how much, and what kinds, of EMC an object has + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class EMCEntry { private float cost, recoveryPercentage; diff --git a/ee3_common/ee3/common/emc/EMCRegistry.java b/ee3_common/ee3/common/emc/EMCRegistry.java index 48387402..fc1f8892 100644 --- a/ee3_common/ee3/common/emc/EMCRegistry.java +++ b/ee3_common/ee3/common/emc/EMCRegistry.java @@ -7,6 +7,15 @@ import net.minecraft.src.Block; import net.minecraft.src.Item; import net.minecraft.src.ItemStack; +/** + * EMCRegistry + * + * Registry containing all EMC entries for objects + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class EMCRegistry { private static final EMCRegistry emcRegistry = new EMCRegistry(); diff --git a/ee3_common/ee3/common/emc/EMCType.java b/ee3_common/ee3/common/emc/EMCType.java index 79844d02..613ab8d4 100644 --- a/ee3_common/ee3/common/emc/EMCType.java +++ b/ee3_common/ee3/common/emc/EMCType.java @@ -1,5 +1,14 @@ package ee3.common.emc; +/** + * EMCType + * + * Enum containing the different types of EMC available in the mod + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public enum EMCType { CORPOREAL, KINETIC, TEMPORAL, ESSENTIA, AMORPHOUS, VOID, OMNI } diff --git a/ee3_common/ee3/common/item/ITransmutationStone.java b/ee3_common/ee3/common/item/ITransmutationStone.java index 11614083..0d74043f 100644 --- a/ee3_common/ee3/common/item/ITransmutationStone.java +++ b/ee3_common/ee3/common/item/ITransmutationStone.java @@ -1,5 +1,14 @@ package ee3.common.item; +/** + * ITransmutationStone + * + * Transmutation Stone interface, for use amongst all different kinds of transmutation stones + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public interface ITransmutationStone { public abstract void openPortableCraftingGui(); diff --git a/ee3_common/ee3/common/item/ItemInertStone.java b/ee3_common/ee3/common/item/ItemInertStone.java index 5d965ddc..215a3888 100644 --- a/ee3_common/ee3/common/item/ItemInertStone.java +++ b/ee3_common/ee3/common/item/ItemInertStone.java @@ -1,5 +1,14 @@ package ee3.common.item; +/** + * ItemInertStone + * + * An inert stone + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class ItemInertStone extends ItemEE { public ItemInertStone(int id) { diff --git a/ee3_common/ee3/common/lib/Colours.java b/ee3_common/ee3/common/lib/Colours.java index ca7ec180..070979e6 100644 --- a/ee3_common/ee3/common/lib/Colours.java +++ b/ee3_common/ee3/common/lib/Colours.java @@ -1,5 +1,14 @@ package ee3.common.lib; +/** + * Colours + * + * Library containing the default colour values used in the mod + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class Colours { public static final String PURE_RED = "ff0000"; diff --git a/ee3_common/ee3/common/lib/ConfigurationSettings.java b/ee3_common/ee3/common/lib/ConfigurationSettings.java index 7efa81bf..739f8225 100644 --- a/ee3_common/ee3/common/lib/ConfigurationSettings.java +++ b/ee3_common/ee3/common/lib/ConfigurationSettings.java @@ -2,6 +2,15 @@ package ee3.common.lib; import ee3.common.item.ModItems; +/** + * ConfigurationSettings + * + * Stores the various configuration settings read in from configuration files + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class ConfigurationSettings { /* diff --git a/ee3_common/ee3/common/lib/GuiIds.java b/ee3_common/ee3/common/lib/GuiIds.java index 4308ae1a..d782b80d 100644 --- a/ee3_common/ee3/common/lib/GuiIds.java +++ b/ee3_common/ee3/common/lib/GuiIds.java @@ -1,5 +1,14 @@ package ee3.common.lib; +/** + * GuiIds + * + * Library containing the various ids for different Guis in the mod + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class GuiIds { public static final int PORTABLE_CRAFTING = 1; diff --git a/ee3_common/ee3/common/lib/PacketIds.java b/ee3_common/ee3/common/lib/PacketIds.java index c30b6505..6880064e 100644 --- a/ee3_common/ee3/common/lib/PacketIds.java +++ b/ee3_common/ee3/common/lib/PacketIds.java @@ -1,5 +1,14 @@ package ee3.common.lib; +/** + * PacketIds + * + * Library containing the various ids for different packets in the mod + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class PacketIds { public static final int KEYBINDING_PRESSED = 0; diff --git a/ee3_common/ee3/common/lib/RenderIds.java b/ee3_common/ee3/common/lib/RenderIds.java index 4e1d057c..abd291fa 100644 --- a/ee3_common/ee3/common/lib/RenderIds.java +++ b/ee3_common/ee3/common/lib/RenderIds.java @@ -1,5 +1,14 @@ package ee3.common.lib; +/** + * RenderIds + * + * Library containing the various ids for different renders in the mod + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class RenderIds { public static int calcinatorRenderId; diff --git a/ee3_common/ee3/common/network/PacketEE.java b/ee3_common/ee3/common/network/PacketEE.java index 0f0bd8e4..58563f1b 100644 --- a/ee3_common/ee3/common/network/PacketEE.java +++ b/ee3_common/ee3/common/network/PacketEE.java @@ -7,6 +7,15 @@ import java.io.IOException; import cpw.mods.fml.common.network.Player; import net.minecraft.src.INetworkManager; +/** + * PacketEE + * + * General packet for EE3 related packets + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class PacketEE { protected PacketTypeHandler packetType; diff --git a/ee3_common/ee3/common/network/PacketKeyPressed.java b/ee3_common/ee3/common/network/PacketKeyPressed.java index 8d71cdf9..8aacf441 100644 --- a/ee3_common/ee3/common/network/PacketKeyPressed.java +++ b/ee3_common/ee3/common/network/PacketKeyPressed.java @@ -15,6 +15,15 @@ import net.minecraft.src.EntityPlayer; import net.minecraft.src.INetworkManager; import net.minecraft.src.Packet250CustomPayload; +/** + * PacketKeyPressed + * + * Packet specifically for notifying the server of client key pressed events + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class PacketKeyPressed extends PacketEE { public String key; diff --git a/ee3_common/ee3/common/network/PacketTileUpdate.java b/ee3_common/ee3/common/network/PacketTileUpdate.java index 4614473f..3e8a6838 100644 --- a/ee3_common/ee3/common/network/PacketTileUpdate.java +++ b/ee3_common/ee3/common/network/PacketTileUpdate.java @@ -9,6 +9,15 @@ import cpw.mods.fml.common.network.Player; import net.minecraft.src.INetworkManager; import net.minecraftforge.common.ForgeDirection; +/** + * PacketTileUpdate + * + * Packet specifically for updating/synching tile entities between client and server + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class PacketTileUpdate extends PacketEE { public int x, y, z; diff --git a/ee3_common/ee3/common/network/PacketTypeHandler.java b/ee3_common/ee3/common/network/PacketTypeHandler.java index ff612ff9..c19cfdc0 100644 --- a/ee3_common/ee3/common/network/PacketTypeHandler.java +++ b/ee3_common/ee3/common/network/PacketTypeHandler.java @@ -8,6 +8,15 @@ import ee3.common.lib.Reference; import net.minecraft.src.Packet; import net.minecraft.src.Packet250CustomPayload; +/** + * PacketTypeHandler + * + * Handler that routes packets to the appropriate destinations depending on what kind of packet they are + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public enum PacketTypeHandler { KEY(PacketKeyPressed.class), TILE(PacketTileUpdate.class); diff --git a/ee3_common/ee3/common/recipe/RecipesCalcinator.java b/ee3_common/ee3/common/recipe/RecipesCalcinator.java index 15efa825..421046c2 100644 --- a/ee3_common/ee3/common/recipe/RecipesCalcinator.java +++ b/ee3_common/ee3/common/recipe/RecipesCalcinator.java @@ -1,5 +1,14 @@ package ee3.common.recipe; +/** + * RecipesCalcinator + * + * Calcinator recipes + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class RecipesCalcinator { } diff --git a/ee3_common/ee3/common/recipe/RecipesTransmutationStone.java b/ee3_common/ee3/common/recipe/RecipesTransmutationStone.java index c6035571..c39e05a3 100644 --- a/ee3_common/ee3/common/recipe/RecipesTransmutationStone.java +++ b/ee3_common/ee3/common/recipe/RecipesTransmutationStone.java @@ -18,6 +18,15 @@ import ee3.common.core.helper.RecipeHelper; import ee3.common.item.ModItems; import ee3.common.lib.Reference; +/** + * RecipesTransmutationStone + * + * Transmutation Stone recipes + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class RecipesTransmutationStone { private static ItemStack philStone = new ItemStack(ModItems.philStone, 1, -1); diff --git a/ee3_common/ee3/common/tile/TileCalcinator.java b/ee3_common/ee3/common/tile/TileCalcinator.java index 87d26ac6..74fd6ab4 100644 --- a/ee3_common/ee3/common/tile/TileCalcinator.java +++ b/ee3_common/ee3/common/tile/TileCalcinator.java @@ -6,6 +6,15 @@ import net.minecraft.src.ItemStack; import net.minecraft.src.NBTTagCompound; import net.minecraft.src.NBTTagList; +/** + * TileCalcinator + * + * Calcinator tile entity, and all the logic associated with it + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class TileCalcinator extends TileEE implements IInventory { /** diff --git a/ee3_common/ee3/common/tile/TileEE.java b/ee3_common/ee3/common/tile/TileEE.java index 19cbccfe..3213f6bf 100644 --- a/ee3_common/ee3/common/tile/TileEE.java +++ b/ee3_common/ee3/common/tile/TileEE.java @@ -5,6 +5,15 @@ import net.minecraft.src.EntityPlayer; import net.minecraft.src.NBTTagCompound; import net.minecraft.src.TileEntity; +/** + * TileEE + * + * General tile entity for EE3 related tile entities + * + * @author pahimar + * @license Lesser GNU Public License v3 (http://www.gnu.org/licenses/lgpl.html) + * + */ public class TileEE extends TileEntity { private byte direction;