From f80c47e8adb9c7810de4ad68890a00593a346ce6 Mon Sep 17 00:00:00 2001 From: Zihlu Wang Date: Mon, 18 Sep 2023 15:04:10 +0800 Subject: [PATCH] docs(global): Optimised javadoc, changed the spelling to British English. --- .../devkit/core/exceptions/package-info.java | 2 +- .../devkit/core/package-info.java | 11 +-- .../org/codecrafters/devkit/package-info.java | 4 +- .../codecrafters/devkit/utils/AesUtil.java | 48 +++++----- .../codecrafters/devkit/utils/Base64Util.java | 39 ++++++-- .../codecrafters/devkit/utils/BranchUtil.java | 18 ++-- .../devkit/utils/ChainedCalcUtil.java | 71 +++++++-------- .../codecrafters/devkit/utils/HashUtil.java | 14 ++- .../codecrafters/devkit/utils/MapUtil.java | 12 +-- .../guid/SnowflakeGuidCreator.java | 18 ++-- .../guid/exceptions/TimingException.java | 14 +-- property-guard-spring-boot-starter/README.md | 2 +- .../autoconfiguration/PropertyGuard.java | 29 ++++-- .../authzero/AuthzeroTokenResolver.java | 51 +++++------ .../config/AuthzeroTokenResolverConfig.java | 91 +++++++++---------- .../simplejwt/authzero/package-info.java | 25 ++--- .../codecrafters/simplejwt/SecretCreator.java | 20 ++-- .../codecrafters/simplejwt/TokenPayload.java | 8 +- .../codecrafters/simplejwt/TokenResolver.java | 8 +- .../annotations/ExcludeFromPayload.java | 15 ++- .../simplejwt/config/TokenResolverConfig.java | 34 ++++--- .../simplejwt/config/package-info.java | 13 +-- .../simplejwt/constants/PredefinedKeys.java | 8 +- .../simplejwt/constants/TokenAlgorithm.java | 4 +- .../UnsupportedAlgorithmException.java | 48 +++++----- .../exceptions/WeakSecretException.java | 54 ++++++----- .../simplejwt/exceptions/package-info.java | 18 ++-- .../codecrafters/simplejwt/package-info.java | 22 ++--- .../simplejwt/jjwt/JjwtTokenResolver.java | 8 +- .../jjwt/config/JjwtTokenResolverConfig.java | 46 +++++----- .../simplejwt/jjwt/package-info.java | 20 ++-- ...uthzeroTokenResolverAutoConfiguration.java | 15 +-- .../GuidAutoConfiguration.java | 2 +- .../JjwtTokenResolverAutoConfiguration.java | 6 +- .../conditions/GuidCreatorCondition.java | 2 +- .../properties/SimpleJwtProperties.java | 12 +-- .../org/codecrafters/webcal/WebCalendar.java | 19 ++-- .../codecrafters/webcal/WebCalendarEvent.java | 19 ++-- .../codecrafters/webcal/WebCalendarNode.java | 13 ++- .../webcal/config/Classification.java | 26 +----- .../webcal/config/package-info.java | 8 +- 41 files changed, 459 insertions(+), 438 deletions(-) diff --git a/devkit-core/src/main/java/cn/org/codecrafters/devkit/core/exceptions/package-info.java b/devkit-core/src/main/java/cn/org/codecrafters/devkit/core/exceptions/package-info.java index 826c497..dfac4fe 100644 --- a/devkit-core/src/main/java/cn/org/codecrafters/devkit/core/exceptions/package-info.java +++ b/devkit-core/src/main/java/cn/org/codecrafters/devkit/core/exceptions/package-info.java @@ -16,7 +16,7 @@ */ /** - * Commonly used exceptions will be used in JDevKit. + * This package contains commonly used exceptions will be used in JDevKit. * * @author Zihlu Wang * @since 1.0.0 diff --git a/devkit-core/src/main/java/cn/org/codecrafters/devkit/core/package-info.java b/devkit-core/src/main/java/cn/org/codecrafters/devkit/core/package-info.java index 3dda72c..a7e930f 100644 --- a/devkit-core/src/main/java/cn/org/codecrafters/devkit/core/package-info.java +++ b/devkit-core/src/main/java/cn/org/codecrafters/devkit/core/package-info.java @@ -16,19 +16,16 @@ */ /** - * 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. - * + * This package is the core 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 entire JDevKit project. *

* JDevKit is designed to be modular, and other specific feature modules within * the library may rely on these exceptions from the core package. - * *

* For more information and the latest version of JDevKit, please visit our * website codecrafters.org.cn. - * *

* Contact *