Merge pull request #162 from kevin70/master

OpenAPI uses javadoc for fields

Author: rbygrave

http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/SchemaDocBuilder.java

@@ -2,6 +2,7 @@
 
 import static io.avaje.http.generator.core.Util.typeDef;
 
+import io.avaje.http.generator.core.javadoc.Javadoc;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -223,6 +224,7 @@ private <T> void populateObjectSchema(TypeMirror objectType, Schema<T> objectSch
       if (isNotNullable(field)) {
         propSchema.setNullable(Boolean.FALSE);
       }
+      setDescription(field, propSchema);
       setLengthMinMax(field, propSchema);
       setFormatFromValidation(field, propSchema);
       objectSchema.addProperties(field.getSimpleName().toString(), propSchema);
@@ -236,6 +238,13 @@ private void setFormatFromValidation(Element element, Schema<?> propSchema) {
     }
   }
 
+  private void setDescription(Element element, Schema<?> propSchema) {
+    var doc = Javadoc.parse(elements.getDocComment(element));
+    if (!doc.getSummary().isEmpty()) {
+      propSchema.setDescription(doc.getSummary());
+    }
+  }
+
   private void setLengthMinMax(Element element, Schema<?> propSchema) {
     SizePrism.getOptionalOn(element)
         .ifPresent(

tests/test-javalin-jsonb/src/main/java/org/example/myapp/web/HelloDto.java

@@ -8,7 +8,13 @@
 public class HelloDto {
 
   public int id;
+  /**
+   * This is a comment.
+   */
   public String name;
+  /**
+   * This is a comment
+   */
   public String otherParam;
   private UUID gid;