doc update

Author: bnasslahsen

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

@@ -940,6 +940,9 @@ else if (existingOperation != null) {
 		return operation;
 	}
 
+	/**
+	 * Init open api builder.
+	 */
 	protected void initOpenAPIBuilder() {
 		if (openAPIBuilder.getCachedOpenAPI() != null && springDocConfigProperties.isCacheDisabled()) {
 			openAPIBuilder = openAPIBuilderObjectFactory.getObject();

springdoc-openapi-common/src/main/java/org/springdoc/core/RequestBodyBuilder.java

@@ -152,6 +152,12 @@ private void buildResquestBodyContent(io.swagger.v3.oas.annotations.parameters.R
 		}
 	}
 
+	/**
+	 * Contains response body schema boolean.
+	 *
+	 * @param content the content
+	 * @return the boolean
+	 */
 	private boolean containsResponseBodySchema(Content content) {
 		return content.entrySet().stream().anyMatch(stringMediaTypeEntry -> stringMediaTypeEntry.getValue().getSchema() != null);
 	}

springdoc-openapi-common/src/main/java/org/springdoc/core/SwaggerUiConfigParameters.java

@@ -79,6 +79,9 @@ public class SwaggerUiConfigParameters extends AbstractSwaggerUiConfigProperties
 	 */
 	private String uiRootPath;
 
+	/**
+	 * The Swagger ui config.
+	 */
 	private final SwaggerUiConfigProperties swaggerUiConfig;
 
 	/**

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

@@ -50,7 +50,7 @@ public class AdditionalModelsConverter implements ModelConverter {
 	/**
 	 * Replace with class.
 	 *
-	 * @param source the source 
+	 * @param source the source
 	 * @param target the target
 	 */
 	public static void replaceWithClass(Class source, Class target) {
@@ -60,7 +60,7 @@ public static void replaceWithClass(Class source, Class target) {
 	/**
 	 * Replace with schema.
 	 *
-	 * @param source the source 
+	 * @param source the source
 	 * @param target the target
 	 */
 	public static void replaceWithSchema(Class source, Schema target) {
@@ -70,7 +70,7 @@ public static void replaceWithSchema(Class source, Schema target) {
 	/**
 	 * Gets replacement.
 	 *
-	 * @param clazz the clazz 
+	 * @param clazz the clazz
 	 * @return the replacement
 	 */
 	public static Class getReplacement(Class clazz) {

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

@@ -84,7 +84,7 @@ public static void addResponseTypeToIgnore(Class<?> cls) {
 	/**
 	 * Is response type wrapper boolean.
 	 *
-	 * @param rawClass the raw class 
+	 * @param rawClass the raw class
 	 * @return the boolean
 	 */
 	public static boolean isResponseTypeWrapper(Class<?> rawClass) {
@@ -94,7 +94,7 @@ public static boolean isResponseTypeWrapper(Class<?> rawClass) {
 	/**
 	 * Is response type to ignore boolean.
 	 *
-	 * @param rawClass the raw class 
+	 * @param rawClass the raw class
 	 * @return the boolean
 	 */
 	public static boolean isResponseTypeToIgnore(Class<?> rawClass) {
@@ -126,7 +126,7 @@ public static void removeResponseTypeToIgnore(Class<?> classes) {
 	/**
 	 * Is flux type wrapper boolean.
 	 *
-	 * @param rawClass the raw class 
+	 * @param rawClass the raw class
 	 * @return the boolean
 	 */
 	public static boolean isFluxTypeWrapper(Class<?> rawClass) {

springdoc-openapi-common/src/main/java/org/springdoc/core/converters/models/DefaultPageable.java

@@ -34,8 +34,8 @@ public class DefaultPageable extends Pageable {
 	/**
 	 * Instantiates a new Default pageable.
 	 *
-	 * @param page the page 
-	 * @param size the size 
+	 * @param page the page
+	 * @param size the size
 	 * @param sort the sort
 	 */
 	public DefaultPageable(int page, int size, List<String> sort) {

springdoc-openapi-common/src/main/java/org/springdoc/core/converters/models/Pageable.java

@@ -61,8 +61,8 @@ public class Pageable {
 	/**
 	 * Instantiates a new Pageable.
 	 *
-	 * @param page the page 
-	 * @param size the size 
+	 * @param page the page
+	 * @param size the size
 	 * @param sort the sort
 	 */
 	public Pageable(int page, int size, List<String> sort) {

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

@@ -34,8 +34,8 @@ public interface ParameterCustomizer {
 	/**
 	 * Customize parameter.
 	 *
-	 * @param parameterModel to be customized 
-	 * @param methodParameter original parameter from handler method 
+	 * @param parameterModel to be customized
+	 * @param methodParameter original parameter from handler method
 	 * @return customized parameter
 	 */
 	Parameter customize(Parameter parameterModel, MethodParameter methodParameter);

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

@@ -34,8 +34,8 @@ public interface PropertyCustomizer {
 	/**
 	 * Customize schema.
 	 *
-	 * @param property to be customized 
-	 * @param type form the model class 
+	 * @param property to be customized
+	 * @param type form the model class
 	 * @return customized property
 	 */
 	Schema customize(Schema property, AnnotatedType type);

springdoc-openapi-common/src/main/java/org/springdoc/core/fn/AbstractRouterFunctionVisitor.java

@@ -64,7 +64,7 @@ public void path(String pattern) {
 	/**
 	 * Header.
 	 *
-	 * @param name the name 
+	 * @param name the name
 	 * @param value the value
 	 */
 	public void header(String name, String value) {
@@ -88,7 +88,7 @@ public List<RouterFunctionData> getRouterFunctionDatas() {
 	/**
 	 * Query param.
 	 *
-	 * @param name the name 
+	 * @param name the name
 	 * @param value the value
 	 */
 	public void queryParam(String name, String value) {
@@ -107,7 +107,7 @@ public void pathExtension(String extension) {
 	/**
 	 * Param.
 	 *
-	 * @param name the name 
+	 * @param name the name
 	 * @param value the value
 	 */
 	public void param(String name, String value) {