From be2a682b3279da04f96c92b1beacafa491d48d31 Mon Sep 17 00:00:00 2001 From: Raoul Van den Berge Date: Sun, 30 Oct 2016 00:26:52 +0200 Subject: [PATCH] API doc fixes --- .../craftingmonitor/ICraftingMonitorElementList.java | 10 +--------- .../autocrafting/preview/ICraftingPreviewElement.java | 7 +++++-- .../api/autocrafting/task/ICraftingTask.java | 8 ++++---- .../refinedstorage/api/render/IElementDrawer.java | 2 +- .../refinedstorage/api/util/IFluidStackList.java | 2 +- .../refinedstorage/api/util/IItemStackList.java | 5 ++++- 6 files changed, 16 insertions(+), 18 deletions(-) diff --git a/src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/craftingmonitor/ICraftingMonitorElementList.java b/src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/craftingmonitor/ICraftingMonitorElementList.java index 39858e670..7d64e0ba1 100755 --- a/src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/craftingmonitor/ICraftingMonitorElementList.java +++ b/src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/craftingmonitor/ICraftingMonitorElementList.java @@ -1,6 +1,5 @@ package com.raoulvdberge.refinedstorage.api.autocrafting.craftingmonitor; -import java.util.Collection; import java.util.List; public interface ICraftingMonitorElementList { @@ -19,13 +18,6 @@ public interface ICraftingMonitorElementList { */ void add(ICraftingMonitorElement element); - /** - * @param elements a {@link Collection} of {@link ICraftingMonitorElement}s to be added - */ - default void addAll(Collection elements) { - elements.forEach(this::add); - } - /** * Finishes a current merge operation. */ @@ -34,7 +26,7 @@ public interface ICraftingMonitorElementList { /** * This also commits the last changes. * - * @return Get the current list of elements + * @return the current list of elements */ List getElements(); } diff --git a/src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/preview/ICraftingPreviewElement.java b/src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/preview/ICraftingPreviewElement.java index 095a4232a..2af9b0218 100755 --- a/src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/preview/ICraftingPreviewElement.java +++ b/src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/preview/ICraftingPreviewElement.java @@ -5,6 +5,9 @@ import io.netty.buffer.ByteBuf; import net.minecraftforge.fml.relauncher.Side; import net.minecraftforge.fml.relauncher.SideOnly; +/** + * Represents a crafting preview element. + */ public interface ICraftingPreviewElement { /** * @return the underlying element to display @@ -30,9 +33,9 @@ public interface ICraftingPreviewElement { int getToCraft(); /** - * When this is true {@link #getToCraft()} will be the missing items + * When this is true {@link #getToCraft()} will be the missing items. * - * @return true when items are missing + * @return true when items are missing, false otherwise */ boolean hasMissing(); diff --git a/src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/task/ICraftingTask.java b/src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/task/ICraftingTask.java index cbb744b46..ad2a115e1 100755 --- a/src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/task/ICraftingTask.java +++ b/src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/task/ICraftingTask.java @@ -46,7 +46,7 @@ public interface ICraftingTask { int getQuantity(); /** - * @return the stack requested + * @return the stack requested, or null if no specific stack is associated with this task */ @Nullable ItemStack getRequested(); @@ -79,7 +79,7 @@ public interface ICraftingTask { } /** - * {@link ICraftingTask#calculate()} must be run before this + * {@link ICraftingTask#calculate()} must be run before this! * * @return the elements of this task for display in the crafting monitor */ @@ -91,9 +91,9 @@ public interface ICraftingTask { ICraftingPattern getPattern(); /** - * {@link ICraftingTask#calculate()} must be run before this + * {@link ICraftingTask#calculate()} must be run before this! * - * @return the processable items in this task + * @return the steps for this task */ List getSteps(); diff --git a/src/main/java/com/raoulvdberge/refinedstorage/api/render/IElementDrawer.java b/src/main/java/com/raoulvdberge/refinedstorage/api/render/IElementDrawer.java index 0f9b49ea0..440da278e 100755 --- a/src/main/java/com/raoulvdberge/refinedstorage/api/render/IElementDrawer.java +++ b/src/main/java/com/raoulvdberge/refinedstorage/api/render/IElementDrawer.java @@ -7,7 +7,7 @@ import com.raoulvdberge.refinedstorage.api.autocrafting.preview.ICraftingPreview * This {@link FunctionalInterface} is used to define a draw/render function. * This function use x and y coords and the element to draw. * Usually packaged in a {@link IElementDrawers}. - * Used in {@link ICraftingPreviewElement#draw(int, int, IElementDrawers)} and {@link ICraftingMonitorElement#draw(int, int, IElementDrawers)} + * Used in {@link ICraftingPreviewElement#draw(int, int, IElementDrawers)} and {@link ICraftingMonitorElement#draw(int, int, IElementDrawers)}. * * @param the element to draw, usually {@link String}, {@link net.minecraft.item.ItemStack} or {@link net.minecraftforge.fluids.FluidStack} */ diff --git a/src/main/java/com/raoulvdberge/refinedstorage/api/util/IFluidStackList.java b/src/main/java/com/raoulvdberge/refinedstorage/api/util/IFluidStackList.java index 5772a6d1d..c857be6cd 100755 --- a/src/main/java/com/raoulvdberge/refinedstorage/api/util/IFluidStackList.java +++ b/src/main/java/com/raoulvdberge/refinedstorage/api/util/IFluidStackList.java @@ -103,7 +103,7 @@ public interface IFluidStackList { void clear(); /** - * Removes all stacks with size zero + * Removes all stacks with size zero. */ void clean(); diff --git a/src/main/java/com/raoulvdberge/refinedstorage/api/util/IItemStackList.java b/src/main/java/com/raoulvdberge/refinedstorage/api/util/IItemStackList.java index 3045d6119..3dc840d1a 100755 --- a/src/main/java/com/raoulvdberge/refinedstorage/api/util/IItemStackList.java +++ b/src/main/java/com/raoulvdberge/refinedstorage/api/util/IItemStackList.java @@ -64,10 +64,13 @@ public interface IItemStackList { } /** - * Restore all tracked removes + * Restore all tracked removes. */ void undo(); + /** + * @return the remove tracker + */ List getRemoveTracker(); /**