From 980db3cd609fa84f3102f1fbc419670ae7231113 Mon Sep 17 00:00:00 2001 From: modmuss50 Date: Mon, 2 Apr 2018 00:12:31 +0100 Subject: [PATCH] Start of making CraftTweaker documentation a bit clearer. --- .../compat/crafttweaker/CTAlloySmelter.java | 1 + .../crafttweaker/CTAssemblingMachine.java | 1 + .../compat/crafttweaker/CTBlastFurnace.java | 1 + .../compat/crafttweaker/CTCentrifuge.java | 1 + .../compat/crafttweaker/CTChemicalReactor.java | 1 + .../compat/crafttweaker/CTCompressor.java | 1 + .../crafttweaker/CTDistillationTower.java | 1 + .../compat/crafttweaker/CTExtractor.java | 1 + .../compat/crafttweaker/CTFluidGen.java | 5 +++++ .../compat/crafttweaker/CTFusionReactor.java | 1 + .../compat/crafttweaker/CTGrinder.java | 1 + .../crafttweaker/CTImplosionCompressor.java | 1 + .../crafttweaker/CTIndustrialElectrolyzer.java | 1 + .../crafttweaker/CTIndustrialGrinder.java | 2 ++ .../crafttweaker/CTIndustrialSawmill.java | 4 ++++ .../compat/crafttweaker/CTRollingMachine.java | 2 ++ .../compat/crafttweaker/CTVacuumFreezer.java | 1 + .../compat/crafttweaker/ZenDocumentation.java | 17 +++++++++++++++++ 18 files changed, 43 insertions(+) create mode 100644 src/main/java/techreborn/compat/crafttweaker/ZenDocumentation.java diff --git a/src/main/java/techreborn/compat/crafttweaker/CTAlloySmelter.java b/src/main/java/techreborn/compat/crafttweaker/CTAlloySmelter.java index 459a89a59..4cbfa56c8 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTAlloySmelter.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTAlloySmelter.java @@ -41,6 +41,7 @@ import techreborn.api.recipe.machines.AlloySmelterRecipe; public class CTAlloySmelter extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output, IIngredient input1, IIngredient input2, int ticktime, int euTick)") public static RecipeSettings addRecipe(IItemStack output, IIngredient input1, IIngredient input2, int ticktime, int euTick) { Object oInput1 = CraftTweakerCompat.toObject(input1); Object oInput2 = CraftTweakerCompat.toObject(input2); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTAssemblingMachine.java b/src/main/java/techreborn/compat/crafttweaker/CTAssemblingMachine.java index c4e2da069..304240036 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTAssemblingMachine.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTAssemblingMachine.java @@ -36,6 +36,7 @@ import techreborn.api.recipe.machines.AssemblingMachineRecipe; public class CTAssemblingMachine extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output, IIngredient input1, IIngredient input2, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output, IIngredient input1, IIngredient input2, int ticktime, int euTick) { Object oInput1 = CraftTweakerCompat.toObject(input1); Object oInput2 = CraftTweakerCompat.toObject(input2); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTBlastFurnace.java b/src/main/java/techreborn/compat/crafttweaker/CTBlastFurnace.java index 858b71e02..000ecefd7 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTBlastFurnace.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTBlastFurnace.java @@ -36,6 +36,7 @@ import techreborn.api.recipe.machines.BlastFurnaceRecipe; public class CTBlastFurnace extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output1, IItemStack output2, IIngredient input1, IIngredient input2, int ticktime, int euTick, int neededHeat") public static RecipeSettings addRecipe(IItemStack output1, IItemStack output2, IIngredient input1, IIngredient input2, int ticktime, int euTick, int neededHeat) { Object oInput1 = CraftTweakerCompat.toObject(input1); Object oInput2 = CraftTweakerCompat.toObject(input2); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTCentrifuge.java b/src/main/java/techreborn/compat/crafttweaker/CTCentrifuge.java index c6fa4e80a..7d7d8db23 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTCentrifuge.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTCentrifuge.java @@ -36,6 +36,7 @@ import techreborn.api.recipe.machines.CentrifugeRecipe; public class CTCentrifuge extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output1, IItemStack output2, IItemStack output3, IItemStack output4, IIngredient input1, IIngredient input2, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output1, IItemStack output2, IItemStack output3, IItemStack output4, IIngredient input1, IIngredient input2, int ticktime, int euTick) { Object oInput1 = CraftTweakerCompat.toObject(input1); Object oInput2 = CraftTweakerCompat.toObject(input2); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTChemicalReactor.java b/src/main/java/techreborn/compat/crafttweaker/CTChemicalReactor.java index 7bbb194fc..1130a4a80 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTChemicalReactor.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTChemicalReactor.java @@ -36,6 +36,7 @@ import techreborn.api.recipe.machines.ChemicalReactorRecipe; public class CTChemicalReactor extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output1, IIngredient input1, IIngredient input2, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output1, IIngredient input1, IIngredient input2, int ticktime, int euTick) { Object oInput1 = CraftTweakerCompat.toObject(input1); Object oInput2 = CraftTweakerCompat.toObject(input2); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTCompressor.java b/src/main/java/techreborn/compat/crafttweaker/CTCompressor.java index 1a71b4616..49bf31d41 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTCompressor.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTCompressor.java @@ -40,6 +40,7 @@ import techreborn.api.recipe.machines.CompressorRecipe; public class CTCompressor extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output1, IIngredient input1, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output1, IIngredient input1, int ticktime, int euTick) { Object oInput1 = CraftTweakerCompat.toObject(input1); CompressorRecipe r = new CompressorRecipe(oInput1, CraftTweakerCompat.toStack(output1), ticktime, euTick); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTDistillationTower.java b/src/main/java/techreborn/compat/crafttweaker/CTDistillationTower.java index f58ae3303..3fd18a792 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTDistillationTower.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTDistillationTower.java @@ -40,6 +40,7 @@ import techreborn.api.recipe.machines.DistillationTowerRecipe; public class CTDistillationTower extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output1, IItemStack output2, IItemStack output3, IItemStack output4, IIngredient input1, IIngredient input2, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output1, IItemStack output2, IItemStack output3, IItemStack output4, IIngredient input1, IIngredient input2, int ticktime, int euTick) { Object oInput1 = CraftTweakerCompat.toObject(input1); Object oInput2 = CraftTweakerCompat.toObject(input2); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTExtractor.java b/src/main/java/techreborn/compat/crafttweaker/CTExtractor.java index bf510e190..9a1e5f446 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTExtractor.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTExtractor.java @@ -38,6 +38,7 @@ import techreborn.api.recipe.machines.ExtractorRecipe; @ZenClass("mods.techreborn.extractor") public class CTExtractor extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output, IIngredient input1, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output, IIngredient input1, int ticktime, int euTick) { Object oInput1 = CraftTweakerCompat.toObject(input1); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTFluidGen.java b/src/main/java/techreborn/compat/crafttweaker/CTFluidGen.java index ea0e96208..194f2dd80 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTFluidGen.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTFluidGen.java @@ -34,26 +34,31 @@ import techreborn.api.generator.GeneratorRecipeHelper; public class CTFluidGen { @ZenMethod + @ZenDocumentation("ILiquidStack fluid, int energyPerMb") public static void addThermalFluid(ILiquidStack fluid, int energyPerMb) { addFluid(EFluidGenerator.THERMAL, fluid, energyPerMb); } @ZenMethod + @ZenDocumentation("ILiquidStack fluid, int energyPerMb") public static void addGasFluid(ILiquidStack fluid, int energyPerMb) { addFluid(EFluidGenerator.GAS, fluid, energyPerMb); } @ZenMethod + @ZenDocumentation("ILiquidStack fluid, int energyPerMb") public static void addSemiFluid(ILiquidStack fluid, int energyPerMb) { addFluid(EFluidGenerator.SEMIFLUID, fluid, energyPerMb); } @ZenMethod + @ZenDocumentation("ILiquidStack fluid, int energyPerMb") public static void addDieselFluid(ILiquidStack fluid, int energyPerMb) { addFluid(EFluidGenerator.DIESEL, fluid, energyPerMb); } @ZenMethod + @ZenDocumentation("ILiquidStack fluid, int energyPerMb") public static void addPlasmaFluid(ILiquidStack fluid, int energyPerMb) { addFluid(EFluidGenerator.PLASMA, fluid, energyPerMb); } diff --git a/src/main/java/techreborn/compat/crafttweaker/CTFusionReactor.java b/src/main/java/techreborn/compat/crafttweaker/CTFusionReactor.java index 2870f1374..ade5ba389 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTFusionReactor.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTFusionReactor.java @@ -43,6 +43,7 @@ import java.util.List; public class CTFusionReactor { @ZenMethod + @ZenDocumentation("IIngredient topInput, IIngredient bottomInput, IItemStack output, int startEU, int euTick, int tickTime") public static void addRecipe(IIngredient topInput, IIngredient bottomInput, IItemStack output, int startEU, int euTick, int tickTime) { FusionReactorRecipe reactorRecipe = new FusionReactorRecipe((ItemStack) CraftTweakerCompat.toObject(topInput), (ItemStack) CraftTweakerCompat.toObject(bottomInput), CraftTweakerCompat.toStack(output), startEU, euTick, tickTime); CraftTweakerAPI.apply(new Add(reactorRecipe)); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTGrinder.java b/src/main/java/techreborn/compat/crafttweaker/CTGrinder.java index c359cb542..2399a378a 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTGrinder.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTGrinder.java @@ -40,6 +40,7 @@ import techreborn.api.recipe.machines.GrinderRecipe; public class CTGrinder extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output, IIngredient input1, int ticktime, int euTick") public static void addRecipe(IItemStack output, IIngredient input1, int ticktime, int euTick) { Object oInput1 = CraftTweakerCompat.toObject(input1); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTImplosionCompressor.java b/src/main/java/techreborn/compat/crafttweaker/CTImplosionCompressor.java index 23a82e15d..5f288b6fe 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTImplosionCompressor.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTImplosionCompressor.java @@ -36,6 +36,7 @@ import techreborn.api.recipe.machines.ImplosionCompressorRecipe; public class CTImplosionCompressor extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output1, IItemStack output2, IIngredient input1, IIngredient input2, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output1, IItemStack output2, IIngredient input1, IIngredient input2, int ticktime, int euTick) { Object oInput1 = CraftTweakerCompat.toObject(input1); Object oInput2 = CraftTweakerCompat.toObject(input2); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTIndustrialElectrolyzer.java b/src/main/java/techreborn/compat/crafttweaker/CTIndustrialElectrolyzer.java index 6aba5a820..5e5a1f647 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTIndustrialElectrolyzer.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTIndustrialElectrolyzer.java @@ -36,6 +36,7 @@ import techreborn.api.recipe.machines.IndustrialElectrolyzerRecipe; public class CTIndustrialElectrolyzer extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output1, IItemStack output2, IItemStack output3, IItemStack output4, IIngredient cells, IIngredient input2, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output1, IItemStack output2, IItemStack output3, IItemStack output4, IIngredient cells, IIngredient input2, int ticktime, int euTick) { Object oInput1 = CraftTweakerCompat.toObject(cells); Object oInput2 = CraftTweakerCompat.toObject(input2); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTIndustrialGrinder.java b/src/main/java/techreborn/compat/crafttweaker/CTIndustrialGrinder.java index 3082001cd..0265b3d90 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTIndustrialGrinder.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTIndustrialGrinder.java @@ -52,6 +52,7 @@ public class CTIndustrialGrinder extends CTGeneric { * @param euTick Amount of EU per tick consumed during crafting */ @ZenMethod + @ZenDocumentation("IItemStack output1, IItemStack output2, IItemStack output3, IItemStack output4, IIngredient input1, IIngredient input2, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output1, IItemStack output2, IItemStack output3, IItemStack output4, IIngredient input1, IIngredient input2, int ticktime, int euTick) { return addRecipe(output1, output2, output3, output4, input1, input2, null, ticktime, euTick); } @@ -69,6 +70,7 @@ public class CTIndustrialGrinder extends CTGeneric { * @param euTick Amount of EU per tick consumed during crafting */ @ZenMethod + @ZenDocumentation("IItemStack output1, IItemStack output2, IItemStack output3, IItemStack output4, IIngredient input1, IIngredient input2, ILiquidStack fluid, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output1, IItemStack output2, IItemStack output3, IItemStack output4, IIngredient input1, IIngredient input2, ILiquidStack fluid, int ticktime, int euTick) { Object oInput1 = CraftTweakerCompat.toObject(input1); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTIndustrialSawmill.java b/src/main/java/techreborn/compat/crafttweaker/CTIndustrialSawmill.java index 582b54922..bec9455e1 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTIndustrialSawmill.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTIndustrialSawmill.java @@ -38,21 +38,25 @@ import techreborn.api.recipe.machines.IndustrialSawmillRecipe; public class CTIndustrialSawmill extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output1, IItemStack output2, IItemStack output3, IIngredient input1, ILiquidStack fluid, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output1, IItemStack output2, IItemStack output3, IIngredient input1, ILiquidStack fluid, int ticktime, int euTick) { return addRecipe(output1, output2, output3, input1, fluid, ticktime, euTick, true); } @ZenMethod + @ZenDocumentation("IItemStack output1, IItemStack output2, IItemStack output3, IIngredient input1, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output1, IItemStack output2, IItemStack output3, IIngredient input1, int ticktime, int euTick) { return addRecipe(output1, output2, output3, input1, null, ticktime, euTick, true); } @ZenMethod + @ZenDocumentation("IItemStack output1, IItemStack output2, IItemStack output3, IIngredient input1, int ticktime, int euTick, boolean useOreDic") public static RecipeSettings addRecipe(IItemStack output1, IItemStack output2, IItemStack output3, IIngredient input1, int ticktime, int euTick, boolean useOreDic) { return addRecipe(output1, output2, output3, input1, null, ticktime, euTick, useOreDic); } @ZenMethod + @ZenDocumentation("IItemStack output1, IItemStack output2, IItemStack output3, IIngredient input1, ILiquidStack fluid, int ticktime, int euTick, boolean useOreDic") public static RecipeSettings addRecipe(IItemStack output1, IItemStack output2, IItemStack output3, IIngredient input1, ILiquidStack fluid, int ticktime, int euTick, boolean useOreDic) { Object oInput1 = CraftTweakerCompat.toObject(input1); diff --git a/src/main/java/techreborn/compat/crafttweaker/CTRollingMachine.java b/src/main/java/techreborn/compat/crafttweaker/CTRollingMachine.java index fc9742771..2a207eee6 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTRollingMachine.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTRollingMachine.java @@ -46,11 +46,13 @@ import java.util.Map; public class CTRollingMachine { @ZenMethod + @ZenDocumentation("IItemStack output, IIngredient[][] ingredients") public static void addShaped(IItemStack output, IIngredient[][] ingredients) { TechRebornAPI.addRollingOreMachinceRecipe(RollingMachineRecipe.getNameForRecipe(CraftTweakerCompat.toStack(output)), CraftTweakerCompat.toStack(output), toShapedObjects(ingredients)); } @ZenMethod + @ZenDocumentation("IItemStack output, IIngredient[] ingredients") public static void addShapeless(IItemStack output, IIngredient[] ingredients) { TechRebornAPI.addShapelessOreRollingMachinceRecipe(RollingMachineRecipe.getNameForRecipe(CraftTweakerCompat.toStack(output)), CraftTweakerCompat.toStack(output), toObjects(ingredients)); } diff --git a/src/main/java/techreborn/compat/crafttweaker/CTVacuumFreezer.java b/src/main/java/techreborn/compat/crafttweaker/CTVacuumFreezer.java index 1dc748136..1d540c3f4 100644 --- a/src/main/java/techreborn/compat/crafttweaker/CTVacuumFreezer.java +++ b/src/main/java/techreborn/compat/crafttweaker/CTVacuumFreezer.java @@ -36,6 +36,7 @@ import techreborn.api.recipe.machines.VacuumFreezerRecipe; public class CTVacuumFreezer extends CTGeneric { @ZenMethod + @ZenDocumentation("IItemStack output, IIngredient input, int ticktime, int euTick") public static RecipeSettings addRecipe(IItemStack output, IIngredient input, int ticktime, int euTick) { Object oInput1 = CraftTweakerCompat.toObject(input); diff --git a/src/main/java/techreborn/compat/crafttweaker/ZenDocumentation.java b/src/main/java/techreborn/compat/crafttweaker/ZenDocumentation.java new file mode 100644 index 000000000..721147d5d --- /dev/null +++ b/src/main/java/techreborn/compat/crafttweaker/ZenDocumentation.java @@ -0,0 +1,17 @@ +package techreborn.compat.crafttweaker; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * This is used to give better detail for a method's parameters when generating the crafttweaker documentation. + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.METHOD) +public @interface ZenDocumentation { + + String value(); + +}