docs(global): Optimised javadoc, changed the spelling to British English.
This commit is contained in:
+8
-7
@@ -34,20 +34,21 @@ import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.DependsOn;
|
||||
|
||||
/**
|
||||
* SimpleJwtAutoConfiguration is responsible for automatically configuring the
|
||||
* Simple JWT library with {@code com.auth0:java-jwt} when used in a Spring
|
||||
* Boot application. It provides default settings and configurations to ensure
|
||||
* that the library works smoothly without requiring manual configuration.
|
||||
* {@code AuthzeroTokenResolverAutoConfiguration} is responsible for
|
||||
* automatically configuring the Simple JWT library with
|
||||
* {@code com.auth0:java-jwt} when used in a Spring Boot application. It
|
||||
* provides default settings and configurations to ensure that the library
|
||||
* works smoothly without requiring manual configuration.
|
||||
* <p>
|
||||
* This autoconfiguration class sets up the necessary beans and components
|
||||
* required for JWT generation and validation. It automatically creates and
|
||||
* configures the {@link TokenResolver} bean based on the available options and
|
||||
* properties.
|
||||
* configures the {@link AuthzeroTokenResolver} bean based on the available
|
||||
* options and properties.
|
||||
* <p>
|
||||
* Developers using the Simple JWT library with Spring Boot do not need to
|
||||
* explicitly configure the library, as the autoconfiguration takes care of
|
||||
* setting up the necessary components and configurations automatically.
|
||||
* However, developers still have the flexibility to customize the behavior of
|
||||
* However, developers still have the flexibility to customise the behavior of
|
||||
* the library by providing their own configurations and properties.
|
||||
*
|
||||
* @author Zihlu Wang
|
||||
|
||||
+1
-1
@@ -29,7 +29,7 @@ import org.springframework.context.annotation.Conditional;
|
||||
import java.util.UUID;
|
||||
|
||||
/**
|
||||
* Autoconfiguration for injecting a {@code GuidCreator} for generating jwt id.
|
||||
* Autoconfiguration for injecting a {@link GuidCreator} for generating jwt id.
|
||||
*
|
||||
* @author Zihlu Wang
|
||||
* @version 1.1.0
|
||||
|
||||
+3
-3
@@ -34,7 +34,7 @@ import org.springframework.boot.context.properties.EnableConfigurationProperties
|
||||
import org.springframework.context.annotation.Bean;
|
||||
|
||||
/**
|
||||
* JjwtTokenResolverAutoConfiguration is responsible for automatically
|
||||
* {@code JjwtTokenResolverAutoConfiguration} is responsible for automatically
|
||||
* configuring the Simple JWT library with {@code io.jsonwebtoken:jjwt-api}
|
||||
* when used in a Spring Boot application. It provides default settings and
|
||||
* configurations to ensure that the library works smoothly without requiring
|
||||
@@ -42,8 +42,8 @@ import org.springframework.context.annotation.Bean;
|
||||
* <p>
|
||||
* This autoconfiguration class sets up the necessary beans and components
|
||||
* required for JWT generation and validation. It automatically creates and
|
||||
* configures the {@link TokenResolver} bean based on the available options and
|
||||
* properties.
|
||||
* configures the {@link JjwtTokenResolver} bean based on the available options
|
||||
* and properties.
|
||||
* <p>
|
||||
* Developers using the Simple JWT library with Spring Boot do not need to
|
||||
* explicitly configure the library, as the autoconfiguration takes care of
|
||||
|
||||
+1
-1
@@ -9,7 +9,7 @@ import org.springframework.core.type.AnnotatedTypeMetadata;
|
||||
import java.util.Objects;
|
||||
|
||||
/**
|
||||
* The condition to create bean {@code jtiCreator}.
|
||||
* The conditions to create bean {@code jtiCreator}.
|
||||
*
|
||||
* @author Zihlu Wang
|
||||
* @version 1.1.0
|
||||
|
||||
+6
-6
@@ -25,20 +25,20 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* {@code SimpleJwtProperties} is a configuration properties class used to
|
||||
* store the properties related to Simple JWT library configuration. These
|
||||
* store the properties related to Simple JWT library configurations. These
|
||||
* properties can be configured in the application's properties file (e.g.,
|
||||
* application.properties) with the prefix "code-crafters.simple-jwt".
|
||||
* <p>
|
||||
* SimpleJwtProperties provides configuration options for the JWT algorithm,
|
||||
* issuer, and secret. The properties are used by the {@link
|
||||
* {@code SimpleJwtProperties} provides configuration options for the JWT
|
||||
* algorithm, issuer, and secret. The properties are used by the {@link
|
||||
* AuthzeroTokenResolverAutoConfiguration} and {@link
|
||||
* cn.org.codecrafters.simplejwt.jjwt.JjwtTokenResolver} to set up the
|
||||
* necessary configurations for JWT generation and validation.
|
||||
* <p>
|
||||
* Developers can customize the JWT algorithm, issuer, and secret by setting
|
||||
* Developers can customise the JWT algorithm, issuer, and secret by setting
|
||||
* the corresponding properties in the application's properties file. The
|
||||
* SimpleJwtAutoConfiguration class reads these properties and uses them to
|
||||
* create the TokenResolver bean with the desired configuration.
|
||||
* {@code SimpleJwtAutoConfiguration} class reads these properties and uses
|
||||
* them to create the TokenResolver bean with the desired configuration.
|
||||
*
|
||||
* @author Zihlu Wang
|
||||
* @version 1.1.0
|
||||
|
||||
Reference in New Issue
Block a user