Update docs

This commit is contained in:
Raoul Van den Berge
2016-09-17 13:47:31 +02:00
parent d78005b2c2
commit 5ce4d7205b

View File

@@ -3,6 +3,7 @@ package refinedstorage.api.solderer;
import net.minecraft.item.ItemStack; import net.minecraft.item.ItemStack;
import javax.annotation.Nonnull; import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/** /**
* A basic solderer recipe. * A basic solderer recipe.
@@ -14,9 +15,9 @@ public class SoldererRecipe implements ISoldererRecipe {
private ItemStack[] rows; private ItemStack[] rows;
/** /**
* @param result The result * @param result the result
* @param duration The duration in ticks * @param duration the duration in ticks
* @param rows The rows of this recipe, has to be 3 rows (null for an empty row) * @param rows the rows of this recipe, has to be 3 rows (null for an empty row)
*/ */
public SoldererRecipe(@Nonnull ItemStack result, int duration, ItemStack... rows) { public SoldererRecipe(@Nonnull ItemStack result, int duration, ItemStack... rows) {
if (rows.length != 3) { if (rows.length != 3) {
@@ -28,16 +29,28 @@ public class SoldererRecipe implements ISoldererRecipe {
this.rows = rows; this.rows = rows;
} }
/**
* @param row the row in the solderer that we want the stack for (between 0 - 2)
* @return a stack for that row, null if there is no stack
*/
@Override @Override
@Nullable
public ItemStack getRow(int row) { public ItemStack getRow(int row) {
return rows[row]; return rows[row];
} }
/**
* @return the result stack
*/
@Override @Override
@Nonnull
public ItemStack getResult() { public ItemStack getResult() {
return result; return result;
} }
/**
* @return the time it takes to complete this recipe
*/
@Override @Override
public int getDuration() { public int getDuration() {
return duration; return duration;