Add comments to PoiOrdering

Author: 2No2Name

common/src/main/java/net/caffeinemc/mods/lithium/common/world/interests/PoiOrdering.java

@@ -55,6 +55,12 @@ default Comparator<BlockPos> getAsComparator(BlockPos center, PoiManager poiMana
     int compare(BlockPos center, PoiManager poiManager, BlockPos posA, BlockPos posB);
 
 
+    /**
+     * Order:
+     * - lower chunk Y first
+     * - POI type hashmap iteration order
+     * - Typed POI record hashmap iteration order
+     */
     record InChunk() implements PoiOrdering {
 
         public static final InChunk INSTANCE = new InChunk();
@@ -106,6 +112,13 @@ public int compare(BlockPos center, PoiManager poiManager, BlockPos posA, BlockP
         }
     }
 
+
+    /**
+     * Order:
+     * - lower chunk Z first
+     * - lower chunk X first
+     * - InChunk order
+     */
     record InSquare() implements PoiOrdering {
 
         public static final InSquare INSTANCE = new InSquare();
@@ -132,6 +145,12 @@ public int compare(BlockPos center, PoiManager poiManager, BlockPos posA, BlockP
         }
     }
 
+
+    /**
+     * Order:
+     * - lower distance squared first
+     * - InSquare order
+     */
     record L2ThenInSquare() implements PoiOrdering {
 
         public static final L2ThenInSquare INSTANCE = new L2ThenInSquare();
@@ -150,6 +169,12 @@ public int compare(BlockPos center, PoiManager poiManager, BlockPos posA, BlockP
         }
     }
 
+    /**
+     * Order:
+     * - lower distance squared first
+     * - lower Y first
+     * - InSquare order
+     */
     record L2ThenMinYThenInSquare() implements PoiOrdering {
 
         public static final L2ThenMinYThenInSquare INSTANCE = new L2ThenMinYThenInSquare();