v0.15.1.0 - Add some missing docs

- Add docs for ColorMap#getWithBiome
- Add docs for ColorMap.Builder#biome
- Add docs for StormType

Took 23 minutes

Author: nullved

src/main/java/net/nullved/pmweatherapi/util/ColorMap.java

@@ -93,8 +93,16 @@ public Color get(float val) {
         return lookup[idx];
     }
 
+    /**
+     * Retrieves the color value using a color derived from the biome
+     * @param val The value to get a color for
+     * @param biome The biome to derive the starting color from
+     * @param worldPos The world position (for grass color checks)
+     * @return The approximate color for this value
+     * @since 0.15.0.0
+     */
     public Color getWithBiome(float val, Holder<Biome> biome, Vec3 worldPos) {
-        Color startColor = Color.BLACK;
+        Color startColor;
         String rn = biome.getRegisteredName().toLowerCase();
         if (rn.contains("ocean") || rn.contains("river")) startColor = new Color(biome.value().getWaterColor());
         else if (rn.contains("beach") || rn.contains("desert")) {
@@ -191,7 +199,8 @@ public static Builder of(Color base) {
         }
 
         /**
-         * Creates a new {@link ColorMap.Builder} that has a default {@link Color#BLACK} base
+         * Creates a new {@link ColorMap.Builder} that has a default {@link Color#BLACK} base.
+         * This method has no effect unless you use {@link ColorMap#getWithBiome(float, Holder, Vec3)}
          * @return The created {@link ColorMap.Builder}
          * @since 0.15.0.0
          */

src/main/java/net/nullved/pmweatherapi/util/StormType.java

@@ -2,6 +2,10 @@
 
 import dev.protomanly.pmweather.weather.Storm;
 
+/**
+ * An enum holding different storm types
+ * @since 0.15.0.0
+ */
 public enum StormType {
     SUPERCELL(0),
     TORNADO(0, 3),
@@ -20,14 +24,31 @@ public enum StormType {
         this.stage = -1;
     }
 
+    /**
+     * Gets the index of the {@link StormType}
+     * @return The {@link StormType} index
+     * @since 0.15.0.0
+     */
     public int idx() {
         return idx;
     }
 
+    /**
+     * Gets the minimum stage of the {@link StormType}
+     * @return The minimum stage of the {@link StormType}
+     * @since 0.15.0.0
+     */
     public int stage() {
         return stage;
     }
 
+    /**
+     * Determines if the {@link Storm} meets this {@link StormType}'s specification.
+     * If this {@link StormType} defines a `stage` (such as {@link StormType#TORNADO}), the {@link Storm} must be equal to or above that stage
+     * @param storm The {@link Storm} to check
+     * @return {@code true} if this {@link Storm} meets the {@link StormType} specification
+     * @since 0.15.0.0
+     */
     public boolean matches(Storm storm) {
         return storm.stormType == idx && storm.stage >= stage;
     }