dave/refinedstorage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc fixes

Browse Source
This commit is contained in:
Raoul Van den Berge
2016-10-23 15:09:46 +02:00
parent ccfda6c9b1
commit 121aa004e1
4 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/craftingmonitor/ICraftingMonitorElement.java
View File

@@ -52,8 +52,7 @@ public interface ICraftingMonitorElement {
void write(ByteBuf buf); void write(ByteBuf buf);
/** /**
* Merge an element into the current element * Merge an element into the current element.
* Used to in {@link ICraftingMonitorElementList}
* *
* @param element the element to merged with the current one * @param element the element to merged with the current one
* @return true if merge was successful * @return true if merge was successful

11
src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/craftingmonitor/ICraftingMonitorElementList.java Normal file → Executable file
View File

@@ -5,16 +5,15 @@ import java.util.List;
public interface ICraftingMonitorElementList { 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} * @param element the {@link ICraftingMonitorElement}
*/ */
void directAdd(ICraftingMonitorElement element); void directAdd(ICraftingMonitorElement element);
/** /**
* Add a element to the list * Add a element to the list, similar elements will be merged.
* Similar elements will be merged * A {@link #commit()} will stop any following adds to be merged with previous ones.
* A {@link #commit()} will stop any following adds to be merged with previous ones
* *
* @param element the {@link ICraftingMonitorElement} * @param element the {@link ICraftingMonitorElement}
*/ */
@@ -28,12 +27,12 @@ public interface ICraftingMonitorElementList {
} }
/** /**
* Finish a current merge operation * Finishes a current merge operation.
*/ */
void commit(); void commit();
/** /**
* This also commits the last changes * This also commits the last changes.
* *
* @return Get the current list of elements * @return Get the current list of elements
*/ */

6
src/main/java/com/raoulvdberge/refinedstorage/api/autocrafting/task/ICraftingTask.java
View File

@@ -33,7 +33,7 @@ public interface ICraftingTask {
/** /**
* Updates this task. Gets called every few ticks, depending on the speed of the pattern container. * 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 * @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 * @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); 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 * @param tag the tag
* @return the written tag * @return the written tag
@@ -107,7 +107,7 @@ public interface ICraftingTask {
boolean isValid(); 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 * @return get a list of {@link ICraftingPreviewElement}s
*/ */

2
src/main/java/com/raoulvdberge/refinedstorage/api/render/IElementDrawers.java
View File

@@ -36,7 +36,7 @@ public interface IElementDrawers {
} }
/** /**
* DO NOT OVERRIDE * DO NOT OVERRIDE!
* *
* @param <T> any type of drawer * @param <T> any type of drawer
* @return a drawer that does nothing * @return a drawer that does nothing