Fixed a bug that javadoc of record class parameters was not recognized. Fixes springdoc#2131

Author: uc4w6c

springdoc-openapi-common/src/main/java/org/springdoc/core/providers/JavadocProvider.java

@@ -2,7 +2,7 @@
  *
  *  *
  *  *  *
- *  *  *  * Copyright 2019-2022 the original author or authors.
+ *  *  *  * Copyright 2019-2023 the original author or authors.
  *  *  *  *
  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  * you may not use this file except in compliance with the License.
@@ -41,11 +41,19 @@ public interface JavadocProvider {
 	String getClassJavadoc(Class<?> cl);
 
 	/**
-	 * Gets method description.
+	 * Gets param descripton of record class.
 	 *
-	 * @param method the method
-	 * @return the method description
+	 * @param cl the class
+	 * @return map of field and param descriptions
 	 */
+	Map<String, String> getRecordClassParamJavadoc(Class<?> cl);
+
+		/**
+		 * Gets method description.
+		 *
+		 * @param method the method
+		 * @return the method description
+		 */
 	String getMethodJavadocDescription(Method method);
 
 	/**
@@ -88,4 +96,3 @@ public interface JavadocProvider {
 	 */
 	String getFirstSentence(String text);
 }
-

springdoc-openapi-javadoc/src/main/java/org/springdoc/openapi/javadoc/JavadocPropertyCustomizer.java

@@ -2,7 +2,7 @@
  *
  *  *
  *  *  *
- *  *  *  * Copyright 2019-2022 the original author or authors.
+ *  *  *  * Copyright 2019-2023 the original author or authors.
  *  *  *  *
  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  * you may not use this file except in compliance with the License.
@@ -109,13 +109,23 @@ else if (resolvedSchema != null && resolvedSchema.get$ref() != null && resolvedS
 	 * @param fields the fields
 	 * @param existingSchema the existing schema
 	 */
-	private void setJavadocDescription(Class<?> cls, List<Field> fields, Schema existingSchema) {
+	void setJavadocDescription(Class<?> cls, List<Field> fields, Schema existingSchema) {
 		if (existingSchema != null) {
 			if (StringUtils.isBlank(existingSchema.getDescription())) {
 				existingSchema.setDescription(javadocProvider.getClassJavadoc(cls));
 			}
 			Map<String, Schema> properties = existingSchema.getProperties();
-			if (!CollectionUtils.isEmpty(properties))
+			if (!CollectionUtils.isEmpty(properties)) {
+				if (cls.getSuperclass() != null && "java.lang.Record".equals(cls.getSuperclass().getName())) {
+					Map<String, String> recordParamMap = javadocProvider.getRecordClassParamJavadoc(cls);
+					properties.entrySet().stream()
+							.filter(stringSchemaEntry -> StringUtils.isBlank(stringSchemaEntry.getValue().getDescription()))
+							.forEach(stringSchemaEntry -> {
+								if (recordParamMap.containsKey(stringSchemaEntry.getKey()))
+									stringSchemaEntry.getValue().setDescription(recordParamMap.get(stringSchemaEntry.getKey()));
+							});
+				}
+
 				properties.entrySet().stream()
 						.filter(stringSchemaEntry -> StringUtils.isBlank(stringSchemaEntry.getValue().getDescription()))
 						.forEach(stringSchemaEntry -> {
@@ -126,6 +136,7 @@ private void setJavadocDescription(Class<?> cls, List<Field> fields, Schema exis
 									stringSchemaEntry.getValue().setDescription(fieldJavadoc);
 							});
 						});
+			}
 			fields.stream().filter(f -> f.isAnnotationPresent(JsonUnwrapped.class))
 					.forEach(f -> setJavadocDescription(f.getType(), FieldUtils.getAllFieldsList(f.getType()), existingSchema));
 

springdoc-openapi-javadoc/src/main/java/org/springdoc/openapi/javadoc/SpringDocJavadocProvider.java

@@ -2,7 +2,7 @@
  *
  *  *
  *  *  *
- *  *  *  * Copyright 2019-2022 the original author or authors.
+ *  *  *  * Copyright 2019-2023 the original author or authors.
  *  *  *  *
  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  * you may not use this file except in compliance with the License.
@@ -26,6 +26,7 @@
 import java.lang.reflect.Method;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 import com.github.therapi.runtimejavadoc.ClassJavadoc;
 import com.github.therapi.runtimejavadoc.CommentFormatter;
@@ -64,6 +65,19 @@ public String getClassJavadoc(Class<?> cl) {
 		return formatter.format(classJavadoc.getComment());
 	}
 
+	/**
+	 * Gets param descripton of record class.
+	 *
+	 * @param cl the class
+	 * @return map of field and param descriptions
+	 */
+	@Override
+	public Map<String, String> getRecordClassParamJavadoc(Class<?> cl) {
+		ClassJavadoc classJavadoc = RuntimeJavadoc.getJavadoc(cl);
+		return classJavadoc.getRecordComponents().stream()
+				.collect(Collectors.toMap(ParamJavadoc::getName, record -> formatter.format(record.getComment())));
+	}
+
 	/**
 	 * Gets method javadoc description.
 	 *