From 96f7dd2fceabb67bc889301d2f23ecdfa6dff09b Mon Sep 17 00:00:00 2001 From: TheBrokenRail Date: Tue, 4 Aug 2020 18:27:04 -0400 Subject: [PATCH] Add More JavaDoc --- .../energonrelics/util/BlockPosWithDimension.java | 14 ++++++++++++++ .../energonrelics/util/MissingCaseException.java | 3 +++ .../energonrelics/util/WeightedList.java | 14 ++++++++++++++ 3 files changed, 31 insertions(+) diff --git a/src/main/java/com/thebrokenrail/energonrelics/util/BlockPosWithDimension.java b/src/main/java/com/thebrokenrail/energonrelics/util/BlockPosWithDimension.java index 5add7b7..2ef2950 100644 --- a/src/main/java/com/thebrokenrail/energonrelics/util/BlockPosWithDimension.java +++ b/src/main/java/com/thebrokenrail/energonrelics/util/BlockPosWithDimension.java @@ -4,10 +4,24 @@ import net.minecraft.util.math.BlockPos; import net.minecraft.util.registry.RegistryKey; import net.minecraft.world.World; +/** + * Block Position Including Dimension + */ public class BlockPosWithDimension { + /** + * Position + */ public final BlockPos pos; + /** + * Dimension + */ public final RegistryKey dimension; + /** + * Create + * @param pos Position + * @param dimension Dimension + */ public BlockPosWithDimension(BlockPos pos, RegistryKey dimension) { this.pos = pos; this.dimension = dimension; diff --git a/src/main/java/com/thebrokenrail/energonrelics/util/MissingCaseException.java b/src/main/java/com/thebrokenrail/energonrelics/util/MissingCaseException.java index 18ab235..50b73d0 100644 --- a/src/main/java/com/thebrokenrail/energonrelics/util/MissingCaseException.java +++ b/src/main/java/com/thebrokenrail/energonrelics/util/MissingCaseException.java @@ -1,5 +1,8 @@ package com.thebrokenrail.energonrelics.util; +/** + * Missing Switch Case Exception + */ public class MissingCaseException extends RuntimeException { public MissingCaseException(Enum value) { super(value.name()); diff --git a/src/main/java/com/thebrokenrail/energonrelics/util/WeightedList.java b/src/main/java/com/thebrokenrail/energonrelics/util/WeightedList.java index 60d02c9..ef39c9a 100644 --- a/src/main/java/com/thebrokenrail/energonrelics/util/WeightedList.java +++ b/src/main/java/com/thebrokenrail/energonrelics/util/WeightedList.java @@ -4,13 +4,27 @@ import java.util.HashMap; import java.util.Map; import java.util.Random; +/** + * Weighted List + * @param Entry Type + */ public class WeightedList { private final Map map = new HashMap<>(); + /** + * Add Entry + * @param weight Weight + * @param obj Entry + */ public void add(int weight, T obj) { map.put(obj, weight); } + /** + * Pick Entry + * @param random Random + * @return Entry + */ public T pick(Random random) { int totalWeight = 0; for (Map.Entry entry : map.entrySet()) {