some javadoc

Author: RealAntEngineer

build.gradle

@@ -128,7 +128,7 @@ repositories {
 
 dependencies {
     minecraft "net.minecraftforge:forge:${minecraft_version}-${forge_version}"
-
+    //TODO make sure we only depend on catnip
     implementation(fg.deobf("com.simibubi.create:create-${minecraft_version}:${create_version}:slim") { transitive = false })
     implementation(fg.deobf("net.createmod.ponder:Ponder-Forge-${minecraft_version}:${ponder_version}"))
     compileOnly(fg.deobf("dev.engine-room.flywheel:flywheel-forge-api-${minecraft_version}:${flywheel_version}"))
@@ -151,7 +151,7 @@ dependencies {
 
     annotationProcessor "org.spongepowered:mixin:${mixin_version}:processor"
 
-    //worldgen tool
+    //unit test tool
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.0'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.10.0'
 
@@ -222,7 +222,7 @@ publishing {
 
         }
     }
-    repositories {//real publishing -> otherwise
+    repositories {//TODO use a more practical
         maven {
             url = uri("https://maven.pkg.github.com/RealAntEngineer/Formic_API")
             credentials {

src/main/java/com/rae/formicapi/multiblock/MBController.java

@@ -16,6 +16,10 @@
 
 import java.util.Objects;
 
+/**
+ * the main block for the multiblock, this the block that is used for the model, to make the model work you will need
+ * to look at the default offset given in the MBShape for the size chosen
+ */
 public abstract class MBController extends DirectionalBlock {
     protected final MBShape shape;
     final DirectionalBlock structure;

src/main/java/com/rae/formicapi/multiblock/MBShape.java

@@ -13,6 +13,10 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * define how the multiblock structure is made : define the offset of the MBController and the direction
+ * of each MBStructureBlock.
+ */
 public class MBShape {
     //make functions for every sizes
     public static MBShape make3x1x1(MBStructureBlock structure){

src/main/java/com/rae/formicapi/multiblock/MBStructureBlock.java

@@ -35,6 +35,9 @@
 import java.util.Set;
 import java.util.function.Consumer;
 
+/**
+ * Structure Block for a MultiBlock, it always as a full hit-box
+ */
 public class MBStructureBlock extends DirectionalBlock implements IWrenchable, IProxyHoveringInformation {
     protected MBStructureBlock(Properties properties) {
         super(properties);