From 34a8ff7833edaec9de78d68a9daeea87dd79be49 Mon Sep 17 00:00:00 2001
From: FalsePattern <30945458+FalsePattern@users.noreply.github.com>
Date: Mon, 18 Jul 2022 21:49:58 +0200
Subject: [PATCH] put explanation in javadoc

---
 .../ChunkProviderSuperPatcher.java            | 103 +++++++++---------
 1 file changed, 51 insertions(+), 52 deletions(-)

diff --git a/src/main/java/com/falsepattern/endlessids/asm/transformer/ChunkProviderSuperPatcher.java b/src/main/java/com/falsepattern/endlessids/asm/transformer/ChunkProviderSuperPatcher.java
index ff6e3b9..02c5caa 100644
--- a/src/main/java/com/falsepattern/endlessids/asm/transformer/ChunkProviderSuperPatcher.java
+++ b/src/main/java/com/falsepattern/endlessids/asm/transformer/ChunkProviderSuperPatcher.java
@@ -25,10 +25,57 @@ import java.util.function.BiFunction;
 import java.util.function.Function;
 
 /**
- * This class is the bread and butter of the patching logic from now on. It covers about 90% of cases where manual patching
- * was required, and so with a heavy heart, I (finally) implemented a universal patch.
+ * <p>This class is the bread and butter of the patching logic from now on. It covers about 90% of cases where manual patching
+ * was required, and so with a heavy heart, I (finally) implemented a universal patch.</p>
  *
- * See the end of the file for the 2 possibilities that this transformer handles.
+ * <pre>
+ *     Java form:
+ *         ...
+ *         byte[] abyte = chunk.getBiomeArray(); //replace byte[] with short[] and getBiomeArray with getBiomeShortArray
+ *
+ *         for (int k = 0; k < abyte.length; ++k) {
+ *             //Possibility A:
+ *             abyte[k] = (byte)abiomegenbase[k].biomeID; //from local variable //replace byte cast with short cast
+ *
+ *             //Possibility B:
+ *             abyte[k] = (byte)this.biomesToGenerate[k].biomeID; //from arbitrary field //replace byte cast with short cast
+ *         }
+ *         ...
+ *     In ASM form:
+ *
+ *        L1
+ *         ALOAD chunk
+ *         INVOKEVIRTUAL net/minecraft/world/chunk/Chunk.getBiomeArray ()[B //Replace with INVOKEVIRTUAL net/minecraft/world/chunk/Chunk.getBiomeShortArray ()[S
+ *         ASTORE abyte
+ *        L2
+ *         ICONST_0
+ *         ISTORE k
+ *        L3
+ *        FRAME <snip>
+ *         ILOAD k
+ *         ALOAD abyte
+ *         ARRAYLENGTH
+ *         IF_ICMPGE L6
+ *        L4
+ *         ALOAD abyte
+ *         ILOAD k
+ *
+ *         //Possibility A:
+ *         ALOAD abiomegenbase
+ *         //Possibility B:
+ *         ALOAD <something else, usually 0, so only check for 0>
+ *         GETFIELD classname.fieldname : [Lnet/minecraft/world/biome/BiomeGenBase;
+ *
+ *         ILOAD k
+ *         AALOAD
+ *         GETFIELD net/minecraft/world/biome/BiomeGenBase.biomeID : I
+ *         I2B                                                            //Replace with I2S
+ *         BASTORE                                                        //Replace with SASTORE
+ *        L5
+ *         IINC k 1
+ *         GOTO L3
+ *        L6
+ * </pre>
  */
 public class ChunkProviderSuperPatcher implements IClassNodeTransformer {
     private static final String BIOME_GEN_BASE_CLASS = "net/minecraft/world/biome/BiomeGenBase";
@@ -274,52 +321,4 @@ public class ChunkProviderSuperPatcher implements IClassNodeTransformer {
 
         final List<Object> locals = new ArrayList<>();
     }
-}
-/*
-    Java form:
-        ...
-        byte[] abyte = chunk.getBiomeArray(); //replace byte[] with short[] and getBiomeArray with getBiomeShortArray
-
-        for (int k = 0; k < abyte.length; ++k) {
-            //Possibility A:
-            abyte[k] = (byte)abiomegenbase[k].biomeID; //from local variable //replace byte cast with short cast
-
-            //Possibility B:
-            abyte[k] = (byte)this.biomesToGenerate[k].biomeID; //from arbitrary field //replace byte cast with short cast
-        }
-        ...
-    In ASM form:
-
-       L1
-        ALOAD chunk
-        INVOKEVIRTUAL net/minecraft/world/chunk/Chunk.getBiomeArray ()[B //Replace with INVOKEVIRTUAL net/minecraft/world/chunk/Chunk.getBiomeShortArray ()[S
-        ASTORE abyte
-       L2
-        ICONST_0
-        ISTORE k
-       L3
-       FRAME <snip>
-        ILOAD k
-        ALOAD abyte
-        ARRAYLENGTH
-        IF_ICMPGE L6
-       L4
-        ALOAD abyte
-        ILOAD k
-
-        //Possibility A:
-        ALOAD abiomegenbase
-        //Possibility B:
-        ALOAD <something else, usually 0, so only check for 0>
-        GETFIELD classname.fieldname : [Lnet/minecraft/world/biome/BiomeGenBase;
-
-        ILOAD k
-        AALOAD
-        GETFIELD net/minecraft/world/biome/BiomeGenBase.biomeID : I
-        I2B                                                            //Replace with I2S
-        BASTORE                                                        //Replace with SASTORE
-       L5
-        IINC k 1
-        GOTO L3
-       L6
- */
\ No newline at end of file
+}
\ No newline at end of file