Doc fixes
This commit is contained in:
@@ -52,8 +52,7 @@ public interface ICraftingMonitorElement {
|
||||
void write(ByteBuf buf);
|
||||
|
||||
/**
|
||||
* Merge an element into the current element
|
||||
* Used to in {@link ICraftingMonitorElementList}
|
||||
* Merge an element into the current element.
|
||||
*
|
||||
* @param element the element to merged with the current one
|
||||
* @return true if merge was successful
|
||||
|
||||
11
src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/craftingmonitor/ICraftingMonitorElementList.java
Normal file → Executable file
11
src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/craftingmonitor/ICraftingMonitorElementList.java
Normal file → Executable file
@@ -5,16 +5,15 @@ import java.util.List;
|
||||
|
||||
public interface ICraftingMonitorElementList {
|
||||
/**
|
||||
* Directly add to the underlying list without trying to merge
|
||||
* Directly add to the underlying list without trying to merge.
|
||||
*
|
||||
* @param element the {@link ICraftingMonitorElement}
|
||||
*/
|
||||
void directAdd(ICraftingMonitorElement element);
|
||||
|
||||
/**
|
||||
* Add a element to the list
|
||||
* Similar elements will be merged
|
||||
* A {@link #commit()} will stop any following adds to be merged with previous ones
|
||||
* Add a element to the list, similar elements will be merged.
|
||||
* A {@link #commit()} will stop any following adds to be merged with previous ones.
|
||||
*
|
||||
* @param element the {@link ICraftingMonitorElement}
|
||||
*/
|
||||
@@ -28,12 +27,12 @@ public interface ICraftingMonitorElementList {
|
||||
}
|
||||
|
||||
/**
|
||||
* Finish a current merge operation
|
||||
* Finishes a current merge operation.
|
||||
*/
|
||||
void commit();
|
||||
|
||||
/**
|
||||
* This also commits the last changes
|
||||
* This also commits the last changes.
|
||||
*
|
||||
* @return Get the current list of elements
|
||||
*/
|
||||
|
||||
@@ -33,7 +33,7 @@ public interface ICraftingTask {
|
||||
|
||||
/**
|
||||
* Updates this task. Gets called every few ticks, depending on the speed of the pattern container.
|
||||
* {@link ICraftingTask#calculate()} must be run before this
|
||||
* {@link ICraftingTask#calculate()} must be run before this!
|
||||
*
|
||||
* @param usedContainers a map keeping track of used containers and how many times
|
||||
* @return true if this crafting task is finished and can be deleted from the list, false otherwise
|
||||
@@ -60,7 +60,7 @@ public interface ICraftingTask {
|
||||
NBTTagCompound writeToNBT(NBTTagCompound tag);
|
||||
|
||||
/**
|
||||
* Helper method to write default neccesary elements to NBT.
|
||||
* Helper method to write default necessary elements to NBT.
|
||||
*
|
||||
* @param tag the tag
|
||||
* @return the written tag
|
||||
@@ -107,7 +107,7 @@ public interface ICraftingTask {
|
||||
boolean isValid();
|
||||
|
||||
/**
|
||||
* {@link ICraftingTask#calculate()} must be run before this
|
||||
* {@link ICraftingTask#calculate()} must be run before this!
|
||||
*
|
||||
* @return get a list of {@link ICraftingPreviewElement}s
|
||||
*/
|
||||
|
||||
@@ -36,7 +36,7 @@ public interface IElementDrawers {
|
||||
}
|
||||
|
||||
/**
|
||||
* DO NOT OVERRIDE
|
||||
* DO NOT OVERRIDE!
|
||||
*
|
||||
* @param <T> any type of drawer
|
||||
* @return a drawer that does nothing
|
||||
|
||||
Reference in New Issue
Block a user