docs: migrate Javadoc to Markdown #53

Author: Flashky

src/main/java/com/adventofcode/flashk/common/JsonUtil.java

@@ -10,19 +10,18 @@ public final class JsonUtil {
 
 	private JsonUtil() {}
 
-	/**
-	 * Builds a json tree.
-	 * <p>Input accepts basic json and even simple arrays such as:</p>
-	 * <pre>
-	 * [4]
-	 * [1,1,3,1,1]
-	 * [[[],[],8,3],[10]]
-	 * [[2],[3,[[],[1]],[],[0,[10,7]]],[[]],[7,[6],8,[9,0],[2]]]
-	 * </pre>
-	 * <p>This is useful for AoC puzzles such as 2021 day 18 and 2022 day 13.</p>
-	 * @param input the input string
-	 * @return The parsed <code>JsonNode</code> Jackson based tree.
-	 */
+	/// Builds a json tree.
+	///
+    /// Input accepts basic json and even simple arrays such as:
+    /// ```
+    /// [4]
+    /// [1,1,3,1,1]
+    /// [[[],[],8,3],[10]]
+    /// [[2],[3,[[],[1]],[],[0,[10,7]]],[[]],[7,[6],8,[9,0],[2]]]
+    /// ```
+    /// This is useful for AoC puzzles such as 2021 day 18 and 2022 day 13.
+    /// @param input the input string
+    /// @return The parsed `JsonNode` Jackson based tree.
 	public static JsonNode buildTree(String input) {
 		try {
 			ObjectMapper objectMapper = new ObjectMapper();
@@ -32,28 +31,25 @@ public static JsonNode buildTree(String input) {
 		}
 	}
 
-	/**
-	 * Builds a json tree using Gson library.
-	 * <p>Input accepts basic json and even simple arrays such as:</p>
-	 * <pre>
-	 * [4]
-	 * [1,1,3,1,1]
-	 * [[[],[],8,3],[10]]
-	 * [[2],[3,[[],[1]],[],[0,[10,7]]],[[]],[7,[6],8,[9,0],[2]]]
-	 * </pre>
-	 * <p>This is useful for AoC puzzles such as 2021 day 18 and 2022 day 13.</p>
-	 * @param input the input string
-	 * @return The parsed <code>JsonElement</code> Gson based tree.
-	 */
+	/// Builds a json tree using Gson library.
+	/// 
+    /// Input accepts basic json and even simple arrays such as:
+    /// ```
+    /// [4]
+    /// [1,1,3,1,1]
+    /// [[[],[],8,3],[10]]
+    /// [[2],[3,[[],[1]],[],[0,[10,7]]],[[]],[7,[6],8,[9,0],[2]]]
+    /// ```
+    /// This is useful for AoC puzzles such as 2021 day 18 and 2022 day 13.
+    /// @param input the input string
+    /// @return The parsed `JsonElement` Gson based tree.
 	public static JsonElement buildGsonTree(String input) {
 		return new Gson().fromJson(input, JsonElement.class);
 	}
 
-	/**
-	 * Checks if a Gson <code>JsonElement</code> is an integer.
-	 * @param element the element to check
-	 * @return true if element is a primitive integer. False otherwise
-	 */
+	/// Checks if a Gson `JsonElement` is an integer.
+    /// @param element the element to check
+    /// @return true if element is a primitive integer. False otherwise
 	public static boolean isInt(JsonElement element) {
 		return element.isJsonPrimitive() && element.getAsJsonPrimitive().isNumber();
 	}

src/main/java/com/adventofcode/flashk/common/MathUtil.java

@@ -8,20 +8,18 @@ public final class MathUtil {
 
 	private MathUtil() {}
 
-	/**
-	 * Applies the sums of a function over a range of values.
-	 * Example:
-	 * <pre>
-	 *     summation(1, 5, i -> i * i) // returns 55 (1^2 + 2^2 + 3^2 + 4^2 + 5^2)
-	 *     summation(1, 5, i -> i) // returns 15 (1 + 2 + 3 + 4 + 5)
-	 *     summation(0, 0, i -> i) // returns 0 (0)
-	 * </pre>
-	 * @param min the minimum value to start the summation. Must be smaller or equal to max.
-	 * @param max the maximum value to end the summation. Must be greater or equal to min.
-	 * @param summationFunction the function to apply to each value in the range before summing them up.
-	 * @return the summation of the function applied to each value in the range
-	 * @throws IllegalArgumentException if min is greater than max
-	 */
+	/// Applies the sums of a function over a range of values.
+    /// Example:
+    /// ```
+    /// summation(1, 5, i -> i * i) // returns 55 (1^2 + 2^2 + 3^2 + 4^2 + 5^2)
+    /// summation(1, 5, i -> i) // returns 15 (1 + 2 + 3 + 4 + 5)
+    /// summation(0, 0, i -> i) // returns 0 (0)
+    /// ```
+    /// @param min the minimum value to start the summation. Must be smaller or equal to max.
+    /// @param max the maximum value to end the summation. Must be greater or equal to min.
+    /// @param summationFunction the function to apply to each value in the range before summing them up.
+    /// @return the summation of the function applied to each value in the range
+    /// @throws IllegalArgumentException if min is greater than max
 	public static int summation(int min, int max, IntFunction<Integer> summationFunction) {
 
 		if(min > max) {
@@ -37,20 +35,18 @@ public static int summation(int min, int max, IntFunction<Integer> summationFunc
 		return sum;
 	}
 
-    /**
-     * Applies the sums of a function over a range of values.
-     * Example:
-     * <pre>
-     *     summation(1, 5, i -> i * i) // returns 55 (1^2 + 2^2 + 3^2 + 4^2 + 5^2)
-     *     summation(1, 5, i -> i) // returns 15 (1 + 2 + 3 + 4 + 5)
-     *     summation(0, 0, i -> i) // returns 0 (0)
-     * </pre>
-     * @param min the minimum value to start the summation. Must be smaller or equal to max.
-     * @param max the maximum value to end the summation. Must be greater or equal to min.
-     * @param summationFunction the function to apply to each value in the range before summing them up.
-     * @return the summation of the function applied to each value in the range
-     * @throws IllegalArgumentException if min is greater than max
-     */
+    /// Applies the sums of a function over a range of values.
+    /// Example:
+    /// ```
+    /// summation(1, 5, i -> i * i) // returns 55 (1^2 + 2^2 + 3^2 + 4^2 + 5^2)
+    /// summation(1, 5, i -> i) // returns 15 (1 + 2 + 3 + 4 + 5)
+    /// summation(0, 0, i -> i) // returns 0 (0)
+    /// ```
+    /// @param min the minimum value to start the summation. Must be smaller or equal to max.
+    /// @param max the maximum value to end the summation. Must be greater or equal to min.
+    /// @param summationFunction the function to apply to each value in the range before summing them up.
+    /// @return the summation of the function applied to each value in the range
+    /// @throws IllegalArgumentException if min is greater than max
     public static long summation(long min, long max, LongFunction<Long> summationFunction) {
 
         if(min > max) {
@@ -66,20 +62,18 @@ public static long summation(long min, long max, LongFunction<Long> summationFun
         return sum;
     }
 
-    /**
-     * Applies the sums of a function over a range of values.
-     * Example:
-     * <pre>
-     *     summation(1, 5, i -> i * i) // returns 55 (1^2 + 2^2 + 3^2 + 4^2 + 5^2)
-     *     summation(1, 5, i -> i) // returns 15 (1 + 2 + 3 + 4 + 5)
-     *     summation(0, 0, i -> i) // returns 0 (0)
-     * </pre>
-     * @param min the minimum value to start the summation. Must be smaller or equal to max.
-     * @param max the maximum value to end the summation. Must be greater or equal to min.
-     * @param summationFunction the function to apply to each value in the range before summing them up.
-     * @return the summation of the function applied to each value in the range
-     * @throws IllegalArgumentException if min is greater than max
-     */
+    /// Applies the sums of a function over a range of values.
+    /// Example:
+    /// ```
+    /// summation(1, 5, i -> i * i) // returns 55 (1^2 + 2^2 + 3^2 + 4^2 + 5^2)
+    /// summation(1, 5, i -> i) // returns 15 (1 + 2 + 3 + 4 + 5)
+    /// summation(0, 0, i -> i) // returns 0 (0)
+    /// ```
+    /// @param min the minimum value to start the summation. Must be smaller or equal to max.
+    /// @param max the maximum value to end the summation. Must be greater or equal to min.
+    /// @param summationFunction the function to apply to each value in the range before summing them up.
+    /// @return the summation of the function applied to each value in the range
+    /// @throws IllegalArgumentException if min is greater than max
     public static double summation(double min, double max, DoubleFunction<Double> summationFunction) {
 
         if(min > max) {
@@ -95,20 +89,18 @@ public static double summation(double min, double max, DoubleFunction<Double> su
         return sum;
     }
 
-	/**
-	 * Applies the product of a function over a range of values.
-	 * Example:
-	 * <pre>
-	 *     product(1, 5, i -> i * i) // returns 14400 (1^2 * 2^2 * 3^2 * 4^2 * 5^2)
-	 *     product(1, 5, i -> i) // returns 120 (1 * 2 * 3 * 4 * 5)
-	 *     product(0, 0, i -> i) // returns 0 (0)
-	 * </pre>
-	 * @param min the minimum value to start the summation. Must be smaller or equal to max.
-	 * @param max the maximum value to end the summation. Must be greater or equal to min.
-	 * @param productFunction the function to apply to each value in the range before summing them up.
-	 * @return the summation of the function applied to each value in the range
-	 * @throws IllegalArgumentException if min is greater than max
-	 */
+	/// Applies the product of a function over a range of values.
+    /// Example:
+    /// ```
+    /// product(1, 5, i -> i * i) // returns 14400 (1^2 * 2^2 * 3^2 * 4^2 * 5^2)
+    /// product(1, 5, i -> i) // returns 120 (1 * 2 * 3 * 4 * 5)
+    /// product(0, 0, i -> i) // returns 0 (0)
+    /// ```
+    /// @param min the minimum value to start the summation. Must be smaller or equal to max.
+    /// @param max the maximum value to end the summation. Must be greater or equal to min.
+    /// @param productFunction the function to apply to each value in the range before summing them up.
+    /// @return the summation of the function applied to each value in the range
+    /// @throws IllegalArgumentException if min is greater than max
 	public static int product(int min, int max, IntFunction<Integer> productFunction) {
 
 		if(min > max) {
@@ -124,20 +116,18 @@ public static int product(int min, int max, IntFunction<Integer> productFunction
 		return product;
 	}
 
-	/**
-	 * Applies the product of a function over a range of values.
-	 * Example:
-	 * <pre>
-	 *     product(1, 5, i -> i * i) // returns 14400 (1^2 * 2^2 * 3^2 * 4^2 * 5^2)
-	 *     product(1, 5, i -> i) // returns 120 (1 * 2 * 3 * 4 * 5)
-	 *     product(0, 0, i -> i) // returns 0 (0)
-	 * </pre>
-	 * @param min the minimum value to start the summation. Must be smaller or equal to max.
-	 * @param max the maximum value to end the summation. Must be greater or equal to min.
-	 * @param productFunction the function to apply to each value in the range before summing them up.
-	 * @return the summation of the function applied to each value in the range
-	 * @throws IllegalArgumentException if min is greater than max
-	 */
+	/// Applies the product of a function over a range of values.
+    /// Example:
+    /// ```
+    /// product(1, 5, i -> i * i) // returns 14400 (1^2 * 2^2 * 3^2 * 4^2 * 5^2)
+    /// product(1, 5, i -> i) // returns 120 (1 * 2 * 3 * 4 * 5)
+    /// product(0, 0, i -> i) // returns 0 (0)
+    /// ```
+    /// @param min the minimum value to start the summation. Must be smaller or equal to max.
+    /// @param max the maximum value to end the summation. Must be greater or equal to min.
+    /// @param productFunction the function to apply to each value in the range before summing them up.
+    /// @return the summation of the function applied to each value in the range
+    /// @throws IllegalArgumentException if min is greater than max
 	public static long product(long min, long max, LongFunction<Long> productFunction) {
 
 		if(min > max) {