javadoc update

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -354,7 +354,7 @@ protected OpenAPI getOpenApi(Locale locale) {
 	 * Gets open api.
 	 *
 	 * @param serverBaseUrl the server base url
-	 * @param locale the locale
+	 * @param locale        the locale
 	 * @return the open api
 	 */
 	protected OpenAPI getOpenApi(String serverBaseUrl, Locale locale) {
@@ -1023,7 +1023,7 @@ protected Set<RequestMethod> getDefaultAllowedHttpMethods() {
 	 * Customise operation.
 	 *
 	 * @param operation     the operation
-	 * @param components
+	 * @param components    the components
 	 * @param handlerMethod the handler method
 	 * @return the operation
 	 */

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocConfiguration.java

@@ -191,6 +191,11 @@ static BeanFactoryPostProcessor springdocBeanFactoryPostProcessor2() {
 		return SpringdocBeanFactoryConfigurer::initBeanFactoryPostProcessor;
 	}
 
+	/**
+	 * Init extra schemas object.
+	 *
+	 * @return the object
+	 */
 	@Bean
 	@Lazy(false)
 	@ConditionalOnProperty(name = SPRINGDOC_ENABLE_EXTRA_SCHEMAS, matchIfMissing = true)
@@ -386,10 +391,10 @@ SecurityService securityParser(PropertyResolverUtils propertyResolverUtils) {
 	/**
 	 * Parameter builder generic parameter builder.
 	 *
-	 * @param propertyResolverUtils                        the property resolver utils
-	 * @param optionalWebConversionServiceProvider         the optional web conversion service provider
-	 * @param objectMapperProvider                         the object mapper provider
-	 * @param javadocProvider                              the javadoc provider
+	 * @param propertyResolverUtils                the property resolver utils
+	 * @param optionalWebConversionServiceProvider the optional web conversion service provider
+	 * @param objectMapperProvider                 the object mapper provider
+	 * @param javadocProvider                      the javadoc provider
 	 * @return the generic parameter builder
 	 */
 	@Bean

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocHateoasConfiguration.java

@@ -28,8 +28,6 @@
 
 import java.util.Optional;
 
-import com.fasterxml.jackson.core.JsonGenerator;
-import com.fasterxml.jackson.databind.SerializerProvider;
 import org.springdoc.core.converters.CollectionModelContentConverter;
 import org.springdoc.core.converters.HateoasLinksConverter;
 import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
@@ -48,7 +46,6 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
-import org.springframework.hateoas.Links;
 import org.springframework.hateoas.server.LinkRelationProvider;
 
 /**
@@ -99,7 +96,6 @@ CollectionModelContentConverter collectionModelContentConverter(HateoasHalProvid
 	 * @param halProvider               the hal provider
 	 * @param springDocConfigProperties the spring doc config properties
 	 * @return the open api customizer
-	 * @see org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer#serialize(Links, JsonGenerator, SerializerProvider) org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer#serialize(Links, JsonGenerator, SerializerProvider)org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer#serialize(Links, JsonGenerator, SerializerProvider)org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer#serialize(Links, JsonGenerator, SerializerProvider)org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer#serialize(Links, JsonGenerator, SerializerProvider)org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer#serialize(Links, JsonGenerator, SerializerProvider)org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer#serialize(Links, JsonGenerator, SerializerProvider)org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalLinkListSerializer#serialize(Links, JsonGenerator, SerializerProvider)
 	 */
 	@Bean(Constants.LINKS_SCHEMA_CUSTOMIZER)
 	@ConditionalOnMissingBean(name = Constants.LINKS_SCHEMA_CUSTOMIZER)

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/converters/CollectionModelContentConverter.java

@@ -26,11 +26,8 @@
 
 package org.springdoc.core.converters;
 
-import java.util.Collection;
 import java.util.Iterator;
 
-import com.fasterxml.jackson.core.JsonGenerator;
-import com.fasterxml.jackson.databind.SerializerProvider;
 import com.fasterxml.jackson.databind.type.CollectionType;
 import com.fasterxml.jackson.databind.type.TypeBindings;
 import io.swagger.v3.core.converter.AnnotatedType;
@@ -48,8 +45,6 @@
  * Override resolved schema as there is a custom serializer that converts the data to a map before serializing it.
  *
  * @author bnasslahsen
- * @see org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer
- * @see org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer#serialize(Collection, JsonGenerator, SerializerProvider) org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer#serialize(Collection, JsonGenerator, SerializerProvider)org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer#serialize(Collection, JsonGenerator, SerializerProvider)org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer#serialize(Collection, JsonGenerator, SerializerProvider)org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer#serialize(Collection, JsonGenerator, SerializerProvider)org.springframework.hateoas.mediatype.hal.Jackson2HalModule.HalResourcesSerializer#serialize(Collection, JsonGenerator, SerializerProvider)
  */
 public class CollectionModelContentConverter implements ModelConverter {
 

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/converters/PolymorphicModelConverter.java

@@ -260,6 +260,10 @@ private record BeanPropertyBiDefinition(
 		/**
 		 * Retrieves an annotation of the specified type from either the serialization or
 		 * deserialization property definition (field, getter, setter), returning the first available match.
+		 *
+		 * @param <A>  the type parameter
+		 * @param acls the acls
+		 * @return the any annotation
 		 */
 		public <A extends Annotation> A getAnyAnnotation(Class<A> acls) {
 			A anyForSerializationAnnotation = getAnyAnnotation(forSerialization, acls);
@@ -271,13 +275,19 @@ public <A extends Annotation> A getAnyAnnotation(Class<A> acls) {
 		/**
 		 * Checks if any annotation of the specified type exists across serialization
 		 * or deserialization property definitions.
+		 *
+		 * @param <A>  the type parameter
+		 * @param acls the acls
+		 * @return the boolean
 		 */
 		public <A extends Annotation> boolean isAnyAnnotated(Class<A> acls) {
 			return getAnyAnnotation(acls) != null;
 		}
 
 		/**
 		 * Type determined from the primary member for the property being built.
+		 *
+		 * @return the primary type
 		 */
 		public JavaType getPrimaryType() {
 			JavaType forSerializationType = null;

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/customizers/GlobalOpenApiCustomizer.java

@@ -31,7 +31,6 @@
  * customize Open api on default OpenAPI description and groups.
  *
  * @author christophejan
- * @see OpenApiCustomizer default OpenAPI description but not      groups
  */
 public interface GlobalOpenApiCustomizer extends OpenApiCustomizer {
 }

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/customizers/GlobalOperationComponentsCustomizer.java

@@ -37,14 +37,14 @@
  * description and groups
  *
  * @author christophejan
- * @see OperationCustomizer operations on default OpenAPI      description but not groups
  */
 public interface GlobalOperationComponentsCustomizer extends GlobalOperationCustomizer {
 
 	/**
 	 * Customize operation.
 	 *
 	 * @param operation     input operation
+	 * @param components    the components
 	 * @param handlerMethod original handler method
 	 * @return customized operation
 	 */

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/customizers/GlobalOperationCustomizer.java

@@ -32,7 +32,6 @@
  * description and groups
  *
  * @author christophejan
- * @see OperationCustomizer operations on default OpenAPI      description but not groups
  */
 public interface GlobalOperationCustomizer extends OperationCustomizer {
 }

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/customizers/OpenApiCustomizer.java

@@ -33,7 +33,6 @@
  * Open api on default OpenAPI description but not on groups
  *
  * @author bnasslahsen
- * @see GlobalOpenApiCustomizer default OpenAPI description and      groups
  */
 @FunctionalInterface
 public interface OpenApiCustomizer {

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/customizers/OperationCustomizer.java

@@ -36,7 +36,6 @@
  * groups
  *
  * @author bnasslahsen
- * @see GlobalOperationCustomizer operations on default OpenAPI      description and groups
  */
 @FunctionalInterface
 public interface OperationCustomizer {