docs: Fix there is only one <p> tag between 2 paragraphs.

2023-07-31 20:40:14 +08:00
parent 2fef4ab711
commit 373fbf9083
7 changed files with 38 additions and 2 deletions
@@ -29,10 +29,12 @@ import java.util.Base64;
 * Java standard library for performing the encoding and decoding operations.
 * This utility class offers convenient methods to encode and decode strings
 * with different character sets.
+ * </p>
 * <p>
 * This class is designed as a final class with a private constructor to
 * prevent instantiation. All methods in this class are static, allowing easy
 * access to the Base64 encoding and decoding functionality.
+ * </p>
 * <p>
 * Example usage:
 * <pre>
@@ -46,10 +48,12 @@ import java.util.Base64;
 * String decoded = Base64Util.decode(encoded);
 * System.out.println("Decoded string: " + decoded);
 * </pre>
+ * </p>
 * <p>
 * <b>Note:</b> This utility class uses the default charset (UTF-8) if no
 * specific charset is provided. It is recommended to specify the charset
 * explicitly to ensure consistent encoding and decoding.
+ * </p>
 *
 * @author Zihlu Wang
 * @version 1.0.0
@@ -29,10 +29,12 @@ import java.util.function.Supplier;
 * in Java development by leveraging lambda expressions. It offers convenient
 * methods to replace verbose if...else statements with more concise and
 * expressive functional constructs.
+ * </p>
 * <p>
 * Developers can use the methods in this utility class to streamline their
 * code, enhance readability, and promote a more functional style of
 * programming when dealing with branching logic and conditional statements.
+ * </p>
 * <p>
 * <b>Example:</b>
 * <pre>
@@ -64,11 +66,12 @@ import java.util.function.Supplier;
 *         // do something
 *     });
 * </pre>
- *
+ * </p>
+ * <p>
 * <b>Note:</b>
 * The {@link #and(Boolean...)} and {@link #or(Boolean...)} methods accept any
 * number of boolean expressions.
- * <p>
+ * </p>
 *
 * @param <T> the type of the result to be handled by the methods
 * @author Zihlu Wang
@@ -161,14 +164,18 @@ public final class BranchUtil<T> {
    }

    /**
+     * <p>
     * Handles the result of the boolean expressions by executing the
     * appropriate handler based on the result.
+     * </p>
     * <p>
     * If the result is {@code true}, the {@code ifHandler} is executed. If the
     * result is {@code false} and an {@code elseHandler} is provided, it is
     * executed.
+     * </p>
     * <p>
     * Returns the result of the executed handler.
+     * </p>
     *
     * @param ifHandler   the handler to be executed if the result is
     *                    {@code true}
@@ -190,10 +197,13 @@ public final class BranchUtil<T> {
    }

    /**
+     * <p>
     * Handles the result of the boolean expressions by executing the provided
     * handler if the result is {@code true}.
+     * </p>
     * <p>
     * Returns the result of the executed handler.
+     * </p>
     *
     * @param ifHandler the handler to be executed if the result is
     *                  {@code true}
@@ -204,12 +214,15 @@ public final class BranchUtil<T> {
    }

    /**
+     * <p>
     * Handles the result of the boolean expressions by executing the
     * appropriate handler based on the result.
+     * </p>
     * <p>
     * If the result is {@code true}, the {@code ifHandler} is executed. If the
     * result is {@code false} and an {@code elseHandler} is provided, it is
     * executed.
+     * </p>
     *
     * @param ifHandler   the handler to be executed if the result is
     *                    {@code true}
@@ -24,7 +24,9 @@ import java.util.function.BiFunction;
 import java.util.function.Function;

 /**
+ * <p>
 * Utility class for chained high-precision calculations using BigDecimal.
+ * </p>
 * <p>
 * The ChainedCalcUtil class provides a convenient way to perform chained
 * high-precision calculations using BigDecimal. It allows users to perform
@@ -32,6 +34,7 @@ import java.util.function.Function;
 * and division with customizable precision and scale. By using this utility
 * class, developers can achieve accurate results and avoid precision loss
 * in their calculations.
+ * </p>
 * <p>
 * <b>Usage:</b>
 * <pre>
@@ -80,12 +83,14 @@ import java.util.function.Function;
 *  </pre>
 * The above expressions perform various mathematical calculations using the
 * ChainedCalcUtil class.
+ * </p>
 * <p>
 * <b>Note:</b>
 * The ChainedCalcUtil class internally uses BigDecimal to handle
 * high-precision calculations. It is important to note that BigDecimal
 * operations can be memory-intensive and may have performance implications
 * for extremely large numbers or complex calculations.
+ * </p>
 *
 * @author sunzsh
 * @version 1.0.0
@@ -25,12 +25,15 @@ import java.util.Objects;
 import java.util.Optional;

 /**
+ * <p>
 * Utility class for performing hash operations on strings.
+ * </p>
 * <p>
 * The HashUtil class provides convenient methods for calculating various hash
 * functions on strings, including MD2, MD5, SHA-1, SHA-224, SHA-256, SHA-384,
 * and SHA-512. It allows developers to easily obtain the hash value of a given
 * string using different algorithms.
+ * </p>
 * <p>
 * Example usage:
 * <pre>
@@ -57,12 +60,14 @@ import java.util.Optional;
 * </pre>
 * The above examples demonstrate how to use the HashUtil class to calculate
 * hash values for a given string using different algorithms.
+ * </p>
 * <p>
 * <b>Note:</b>
 * The hash functions provided by the HashUtil class are one-way hash
 * functions, meaning the original data cannot be retrieved from the hash
 * value. These hash functions are commonly used for data integrity checks and
 * password storage, but they should not be used for encryption purposes.
+ * </p>
 *
 * @author Zihlu Wang
 * @version 1.0.0
@@ -24,11 +24,14 @@ import java.util.HashMap;
 import java.util.Map;

 /**
+ * <p>
 * MapUtil is a utility class that provides methods for converting objects to
 * maps and maps to objects.
+ * </p>
 * <p>
 * It also provides methods for getting and setting field values using
 * reflection.
+ * </p>
 *
 * @author Zihlu Wang
 * @version 1.0.0
@@ -23,6 +23,7 @@
 * enhance productivity. This package serves as the root package for the module
 * dev-utils, which contains a collection of common utility classes commonly
 * used in all Java Application development.
+ * </p>
 *
 * @author Zihlu Wang
 * @since 1.0.0
@@ -24,11 +24,13 @@ package cn.org.codecrafters.devkit.core.exceptions;
 * that represents a situation where a particular method or functionality is
 * not implemented or is currently unavailable in the codebase. It extends the
 * standard {@code RuntimeException} class, making it an unchecked exception.
+ * </p>
 * <p>
 * This exception is typically thrown when developers need to indicate that a
 * specific part of the code is incomplete or requires further implementation.
 * It serves as a placeholder to highlight unfinished sections of the
 * application during development and testing phases.
+ * </p>
 * <p>
 * Usage Example:
 * <pre>
@@ -39,9 +41,11 @@ package cn.org.codecrafters.devkit.core.exceptions;
 *     """);
 * }
 * </pre>
+ * </p>
 * <p>
 * For more information and the latest version of JDevKit, please visit our
 * website <a href="https://codecrafters.org.cn">codecrafters.org.cn</a>.
+ * </p>
 * <p>
 * <h4>Contact</h4>
 * <ul>
@@ -53,6 +57,7 @@ package cn.org.codecrafters.devkit.core.exceptions;
 *         <a href="https://discord.gg/">Discord Community</a>
 *     </li>
 * </ul>
+ * </p>
 *
 * @author Zihlu Wang
 * @version 1.0.0