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

This commit is contained in:
Zihlu Wang
2023-07-31 22:53:09 +08:00
parent 715ae6db3a
commit 748e474a82
34 changed files with 220 additions and 184 deletions
@@ -24,15 +24,16 @@ 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>
* public void someMethod() {
* // Some code...
@@ -41,13 +42,8 @@ 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>
*
* <b>Contact</b>
* <ul>
* <li>
* <a href="https://github.com/CodeCraftersCN/jdevkit/issues/new"
@@ -57,7 +53,6 @@ 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
@@ -16,22 +16,21 @@
*/
/**
* <p>
* This package is a part of JDevKit, an open-source Java Development Kit that
* provides a set of convenient tools to streamline code development and
* enhance productivity. This package serves as the core package containing
* common exceptions that are used throughout the entireJDevKit project.
* </p>
*
* <p>
* JDevKit is designed to be modular, and other specific feature modules within
* the library may rely on these exceptions from the core package.
* </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>
* <b>Contact</b>
* <ul>
* <li>
* <a href="https://github.com/CodeCraftersCN/jdevkit/issues/new"
@@ -41,7 +40,6 @@
* <a href="https://discord.gg/">Discord Community</a>
* </li>
* </ul>
* </p>
*
* @since 1.0.0
*/
@@ -16,19 +16,17 @@
*/
/**
* <h3>JDevKit - Java Development Kit</h3>
* <p>
* This package is the main part of JDevKit, an open-source Java class library
* that provides a set of convenient tools to streamline code development and
* enhance productivity. This package serves as the root package for several
* modules, containing devkit-core, guid and dev-utils module.
* </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>
* <b>Contact</b>
* <ul>
* <li>
* <a href="https://github.com/CodeCraftersCN/jdevkit/issues/new"
@@ -38,7 +36,6 @@
* <a href="https://discord.gg/">Discord Community</a>
* </li>
* </ul>
* </p>
*
* @since 1.0.0
*/