Extra documentation for the Stat and StatChange classes

runelite-client/src/main/java/net/runelite/client/plugins/itemstats/StatChange.java

@@ -33,9 +33,30 @@ import net.runelite.client.plugins.itemstats.stats.Stat;
 @Data
 public class StatChange
 {
+	/**
+	 * The stat which will be boosted (or damaged).
+	 */
 	private Stat stat;
+
+	/**
+	 * Relative change that will occur if the stat boost is applied now.
+	 * Should be a number prefixed by "+" or "-".
+	 */
 	private String relative;
-	private String absolute;
+
+	/**
+	 * Theoretical change that can occur before boost cap is enforced.
+	 * Should be a number prefixed by "+" or "-".
+	 */
 	private String theoretical;
+
+	/**
+	 * Absolute total of the stat after applying the boost.
+	 */
+	private String absolute;
+
+	/**
+	 * How beneficial this stat boost will be to the player.
+	 */
 	private Positivity positivity;
 }

runelite-client/src/main/java/net/runelite/client/plugins/itemstats/stats/Stat.java

@@ -46,7 +46,13 @@ public abstract class Stat
 		return name;
 	}
 
+	/**
+	 * Get the current stat value including any boosts or damage.
+	 */
 	public abstract int getValue(Client client);
 
+	/**
+	 * Get the base stat maximum, ie. the bottom half of the stat fraction.
+	 */
 	public abstract int getMaximum(Client client);
 }