From 7ae4cc86c7a4454cdab9d970a91b32d3d6a6d2af Mon Sep 17 00:00:00 2001 From: yueh Date: Sat, 17 Sep 2016 15:22:16 +0200 Subject: [PATCH] Added TODO for API classes needing investigation --- src/api/java/appeng/api/client/BakingPipeline.java | 10 +++++++++- src/api/java/appeng/api/movable/IMovableHandler.java | 2 +- .../api/networking/security/BaseActionSource.java | 4 +++- .../appeng/api/networking/security/MachineSource.java | 4 +++- .../appeng/api/networking/security/PlayerSource.java | 4 +++- src/api/java/appeng/api/parts/LayerBase.java | 2 ++ src/api/java/appeng/api/parts/LayerFlags.java | 4 +++- src/api/java/appeng/api/parts/SelectedPart.java | 3 ++- src/api/java/appeng/api/storage/MEMonitorHandler.java | 4 ++++ src/api/java/appeng/api/util/AEAxisAlignedBB.java | 2 ++ src/api/java/appeng/api/util/AEPartLocation.java | 2 +- src/api/java/appeng/api/util/WorldCoord.java | 2 ++ 12 files changed, 35 insertions(+), 8 deletions(-) diff --git a/src/api/java/appeng/api/client/BakingPipeline.java b/src/api/java/appeng/api/client/BakingPipeline.java index 1bd5fa8f..ac6dd153 100644 --- a/src/api/java/appeng/api/client/BakingPipeline.java +++ b/src/api/java/appeng/api/client/BakingPipeline.java @@ -32,7 +32,12 @@ import net.minecraft.block.state.IBlockState; import net.minecraft.client.renderer.block.model.IBakedModel; import net.minecraft.util.EnumFacing; - +/** + * TODO: Needs to be moved to an internal class. API is only allowed to contain interfaces and/or data. + * + * @deprecated + */ +@Deprecated public class BakingPipeline implements BakingPipelineElement { @@ -43,6 +48,9 @@ public class BakingPipeline implements BakingPipelineElement this.pipeline = ImmutableList.copyOf( pipeline ); } + /** + * TODO: fix generics + */ public List pipe( List things, IBakedModel parent, IBlockState state, EnumFacing side, long rand ) { for( BakingPipelineElement pipe : pipeline ) diff --git a/src/api/java/appeng/api/movable/IMovableHandler.java b/src/api/java/appeng/api/movable/IMovableHandler.java index 5c682ee1..9c08aed5 100644 --- a/src/api/java/appeng/api/movable/IMovableHandler.java +++ b/src/api/java/appeng/api/movable/IMovableHandler.java @@ -55,7 +55,7 @@ public interface IMovableHandler * @code * Chunk c = world.getChunkFromBlockCoords( x, z ); * c.setChunkBlockTileEntity( x & 0xF, y + y, z & 0xF, tile ); - * + * * if( c.isChunkLoaded ) * { * world.addTileEntity( tile ); diff --git a/src/api/java/appeng/api/networking/security/BaseActionSource.java b/src/api/java/appeng/api/networking/security/BaseActionSource.java index bfaa66a2..1a7b6e79 100644 --- a/src/api/java/appeng/api/networking/security/BaseActionSource.java +++ b/src/api/java/appeng/api/networking/security/BaseActionSource.java @@ -23,7 +23,9 @@ package appeng.api.networking.security; - +/** + * TODO: Consider refactoring. + */ public class BaseActionSource { diff --git a/src/api/java/appeng/api/networking/security/MachineSource.java b/src/api/java/appeng/api/networking/security/MachineSource.java index 40a46536..7a6924ee 100644 --- a/src/api/java/appeng/api/networking/security/MachineSource.java +++ b/src/api/java/appeng/api/networking/security/MachineSource.java @@ -23,7 +23,9 @@ package appeng.api.networking.security; - +/** + * TODO: Consider refactoring. + */ public class MachineSource extends BaseActionSource { diff --git a/src/api/java/appeng/api/networking/security/PlayerSource.java b/src/api/java/appeng/api/networking/security/PlayerSource.java index fc6cb37e..76e047e6 100644 --- a/src/api/java/appeng/api/networking/security/PlayerSource.java +++ b/src/api/java/appeng/api/networking/security/PlayerSource.java @@ -26,7 +26,9 @@ package appeng.api.networking.security; import net.minecraft.entity.player.EntityPlayer; - +/** + * TODO: Consider refactoring. + */ public class PlayerSource extends BaseActionSource { diff --git a/src/api/java/appeng/api/parts/LayerBase.java b/src/api/java/appeng/api/parts/LayerBase.java index 58ab49f5..a5c1df88 100644 --- a/src/api/java/appeng/api/parts/LayerBase.java +++ b/src/api/java/appeng/api/parts/LayerBase.java @@ -35,6 +35,8 @@ import appeng.api.util.AEPartLocation; /** * All Layers must extends this, this get part implementation is provided to interface with the parts, however a real * implementation will be used at runtime. + * + * TODO: Consider removing and replacing with capabilities. */ public abstract class LayerBase extends TileEntity // implements IPartHost { diff --git a/src/api/java/appeng/api/parts/LayerFlags.java b/src/api/java/appeng/api/parts/LayerFlags.java index af04459b..89e63593 100644 --- a/src/api/java/appeng/api/parts/LayerFlags.java +++ b/src/api/java/appeng/api/parts/LayerFlags.java @@ -23,7 +23,9 @@ package appeng.api.parts; - +/** + * TODO: Consider removing and replacing with capabilities. + */ public enum LayerFlags { diff --git a/src/api/java/appeng/api/parts/SelectedPart.java b/src/api/java/appeng/api/parts/SelectedPart.java index eade33c8..84396d61 100644 --- a/src/api/java/appeng/api/parts/SelectedPart.java +++ b/src/api/java/appeng/api/parts/SelectedPart.java @@ -28,7 +28,8 @@ import appeng.api.util.AEPartLocation; /** - * Reports a selected part from th IPartHost + * Reports a selected part from the IPartHost + * */ public class SelectedPart { diff --git a/src/api/java/appeng/api/storage/MEMonitorHandler.java b/src/api/java/appeng/api/storage/MEMonitorHandler.java index c8de980d..b962f3d1 100644 --- a/src/api/java/appeng/api/storage/MEMonitorHandler.java +++ b/src/api/java/appeng/api/storage/MEMonitorHandler.java @@ -42,7 +42,11 @@ import appeng.api.storage.data.IItemList; * listeners. * * @param + * @deprecated + * + * TODO: Needs to be redesigned to solve performance issues. Also should not be part of the API as class. */ +@Deprecated public class MEMonitorHandler implements IMEMonitor { diff --git a/src/api/java/appeng/api/util/AEAxisAlignedBB.java b/src/api/java/appeng/api/util/AEAxisAlignedBB.java index c93bcb86..70776b79 100644 --- a/src/api/java/appeng/api/util/AEAxisAlignedBB.java +++ b/src/api/java/appeng/api/util/AEAxisAlignedBB.java @@ -24,6 +24,8 @@ import net.minecraft.util.math.AxisAlignedBB; /** * Mutable stand in for Axis Aligned BB, this was used to prevent GC Thrashing.. Related code could also be re-written. + * + * TODO: Replace with interface and maybe factory should it ever be needed for addons. */ public class AEAxisAlignedBB { diff --git a/src/api/java/appeng/api/util/AEPartLocation.java b/src/api/java/appeng/api/util/AEPartLocation.java index dad7b961..92fc7523 100644 --- a/src/api/java/appeng/api/util/AEPartLocation.java +++ b/src/api/java/appeng/api/util/AEPartLocation.java @@ -94,7 +94,7 @@ public enum AEPartLocation /** * 100% chance of success. - * + * * @param side * @return proper Part Location for a facing enum. */ diff --git a/src/api/java/appeng/api/util/WorldCoord.java b/src/api/java/appeng/api/util/WorldCoord.java index d9d3b734..75d10853 100644 --- a/src/api/java/appeng/api/util/WorldCoord.java +++ b/src/api/java/appeng/api/util/WorldCoord.java @@ -31,6 +31,8 @@ import net.minecraft.util.math.BlockPos; /** * Represents a relative coordinate, either relative to another object, or * relative to the origin of a dimension. + * + * TODO: Consider replacing with {@link BlockPos} */ public class WorldCoord {