docs: Fix all docs from one <p> represents for a paragraph

2023-07-31 22:53:09 +08:00
parent 715ae6db3a
commit 748e474a82
34 changed files with 220 additions and 184 deletions
@@ -21,10 +21,10 @@ package cn.org.codecrafters.guid;
 * <p>
 * The {@code GuidCreator} is a generic interface for generating globally unique
 * identifiers (GUIDs) of a specific type.
- * </p>
+ * 
 * <p>
 * The type of ID is determined by the class implementing this interface.
- * </p>
+ * 
 *
 * @param <IdType> this represents the type of the Global Unique Identifier
 * @author Zihlu Wang
@@ -25,7 +25,7 @@ import java.time.ZoneOffset;
 /**
 * <p>
 * SnowflakeGuidCreator - GUID generator based on the Snowflake algorithm.
- * </p>
+ *
 * <p>
 * The SnowflakeGuidCreator generates unique identifiers using the Snowflake
 * algorithm, which combines a timestamp, worker ID, and data center ID to
@@ -38,7 +38,6 @@ import java.time.ZoneOffset;
 *     <li>5 bits for worker ID</li>
 *     <li>12 bits for sequence number (per millisecond)</li>
 * </ul>
- * </p>
 *
 * <p>
 * When initializing the SnowflakeGuidCreator, you must provide the worker ID
@@ -47,7 +46,6 @@ import java.time.ZoneOffset;
 * increments for IDs generated within the same millisecond. If the system
 * clock moves backward, an exception is thrown to prevent generating IDs with
 * repeated timestamps.
- * </p>
 *
 * @author Zihlu Wang
 * @version 1.0.0
@@ -21,24 +21,24 @@ package cn.org.codecrafters.guid.exceptions;
 * <p>
 * The TimingException class represents an exception that is thrown when there
 * is an error related to time sequence.
- * </p>
+ * 
 * <p>
 * This class extends the RuntimeException class, which means that instances of
 * TimingException do not need to be declared in a method or constructor's
 * throws clause.
- * </p>
+ * 
 * <p>
 * Instances of TimingException can be created with or without a message and a
 * cause. The message provides a description of the exception, while the cause
 * represents the underlying cause of the exception and provides additional
 * information about the error.
- * </p>
+ * 
 * <p>
 * TimingException is typically used to handle exceptions related to timing,
 * such as timeouts or synchronization issues. It is a subclass of
 * RuntimeException, which means it is an unchecked exception and does not need
 * to be caught or declared.
- * </p>
+ * 
 *
 * @author Zihlu Wang
 * @since 1.0.0
@@ -20,14 +20,12 @@
 * This package contains the custom exception classes related to GUID
 * generation. These exceptions are thrown when there are issues or errors
 * during the generation or processing of global unique identifiers (GUIDs).
- * </p>
 *
 * <p>
 * The main exception class in this package is {@link
 * cn.org.codecrafters.guid.exceptions.TimingException}, which is a runtime
 * exception and serves as the base exception for all other custom exceptions
 * related to GUID generation.
- * </p>
 *
 * <p>
 * Custom exceptions in this package provide specific information about the
@@ -36,13 +34,11 @@
 * GUIDs. They are designed to enhance the robustness and reliability of the
 * GUID generation process by providing clear and meaningful error messages to
 * the developers.
- * </p>
 *
 * <p>
 * Developers using the GUID generation module should be aware of the possible
 * exceptions that can be thrown and handle them appropriately to ensure smooth
 * operation and error handling in their applications.
- * </p>
 *
 * @since 1.0.0
 */
@@ -19,12 +19,12 @@
 * <p>
 * The package provides a set of tools for generating globally unique
 * identifiers (GUIDs).
- * </p>
+ * 
 * <p>
 * The goal of this library is to provide an efficient, reliable way to
 * generate globally unique identifiers without requiring any specific
 * environment or configuration.
- * </p>
+ * 
 * <p>
 * Key features include:
 * <ul>
@@ -32,7 +32,6 @@
 *     <li>High performance and quick response</li>
 *     <li>Easy to integrate</li>
 * </ul>
- * </p>
 *
 * @since 1.0.0
 */