Fix record javadoc generation (#63)

Author: andriy-dmytruk

sourcegen-generator-java/src/main/java/io/micronaut/sourcegen/javapoet/MethodSpec.java

@@ -148,7 +148,10 @@ static CodeBlock makeJavadocWithParameters(CodeBlock javadoc,
     for (ParameterSpec parameterSpec : parameters) {
       if (!parameterSpec.javadoc.isEmpty()) {
         // Emit a new line before @param section only if the method javadoc is present.
-        if (emitTagNewline && !javadoc.isEmpty()) builder.add("\n");
+        if (!builder.isEmpty()) {
+            if (emitTagNewline) builder.add("\n");
+            builder.add("\n");
+        }
         emitTagNewline = false;
         builder.add("@param $L $L", parameterSpec.name, parameterSpec.javadoc);
       }

sourcegen-generator-java/src/test/java/io/micronaut/sourcegen/javapoet/MethodSpecTest.java

@@ -297,12 +297,12 @@ abstract static class AbstractClassWithPrivateAnnotation {
   @Test public void withParameterJavaDoc() {
     MethodSpec methodSpec = MethodSpec.methodBuilder("getTaco")
         .addParameter(ParameterSpec.builder(TypeName.DOUBLE, "money")
-            .addJavadoc("the amount required to buy the taco.\n")
+            .addJavadoc("the amount required to buy the taco.")
             .build())
         .addParameter(ParameterSpec.builder(TypeName.INT, "count")
-            .addJavadoc("the number of Tacos to buy.\n")
+            .addJavadoc("the number of Tacos to buy.")
             .build())
-        .addJavadoc("Gets the best Taco money can buy.\n")
+        .addJavadoc("Gets the best Taco money can buy.")
         .build();
     assertThat(methodSpec.toString()).isEqualTo("/**\n"
         + " * Gets the best Taco money can buy.\n"
@@ -317,10 +317,10 @@ abstract static class AbstractClassWithPrivateAnnotation {
   @Test public void withParameterJavaDocAndWithoutMethodJavadoc() {
     MethodSpec methodSpec = MethodSpec.methodBuilder("getTaco")
         .addParameter(ParameterSpec.builder(TypeName.DOUBLE, "money")
-            .addJavadoc("the amount required to buy the taco.\n")
+            .addJavadoc("the amount required to buy the taco.")
             .build())
         .addParameter(ParameterSpec.builder(TypeName.INT, "count")
-            .addJavadoc("the number of Tacos to buy.\n")
+            .addJavadoc("the number of Tacos to buy.")
             .build())
         .build();
     assertThat(methodSpec.toString()).isEqualTo("/**\n"

sourcegen-generator-java/src/test/java/io/micronaut/sourcegen/javapoet/TypeSpecTest.java

@@ -1301,17 +1301,17 @@ public void interfacePrivateMethods() {
   @Test
   public void recordComponentJavadoc() throws Exception {
     TypeSpec taco = TypeSpec.recordBuilder("Taco")
-        .addJavadoc("Wants a cat to be a tacocat.\n")
+        .addJavadoc("Wants a cat to be a tacocat.")
         .addRecordComponent(ParameterSpec.builder(ClassName.get(String.class), "shell")
-            .addJavadoc("the outer level of tortilla of the taco\n")
+            .addJavadoc("the outer level of tortilla of the taco")
             .build())
         .addRecordComponent(ParameterSpec.builder(boolean.class, "soft")
             .addJavadoc("true for a soft flour tortilla, or false for a crunchy corn tortilla\n")
             .build())
         .compactConstructor(MethodSpec.constructorBuilder()
-            .addJavadoc("Makes a taco without a cat :(.\n")
+            .addJavadoc("Makes a taco without a cat :(.")
             .addParameter(ParameterSpec.builder(ClassName.get(String.class), "shell")
-                .addJavadoc("the outer level of tortilla of the taco\n")
+                .addJavadoc("the outer level of tortilla of the taco")
                 .build())
             .build())
         .build();

sourcegen-generator-java/src/test/java/io/micronaut/sourcegen/javapoet/write/RecordWriteTest.java

@@ -46,6 +46,55 @@ record TestRecord(
         assertEquals(expected.strip(), result.strip());
     }
 
+    @Test
+    public void writeRecordWithJavadoc() throws IOException {
+        RecordDef recordDef = RecordDef.builder("test.TestRecord")
+                .addProperty(PropertyDef.builder("name").ofType(String.class)
+                        .addJavadoc("The person's name").build())
+                .addProperty(PropertyDef.builder("age").ofType(Integer.class)
+                        .addJavadoc("The person's age")
+                        .build()
+                )
+                .addJavadoc("A record representing a person.")
+                .build();
+        var result = writeRecord(recordDef);
+
+        var expected = """
+        /**
+         * A record representing a person.
+         *
+         * @param name The person's name
+         * @param age The person's age
+         */
+        record TestRecord(
+            String name,
+            Integer age
+        ) {
+        }
+        """;
+        assertEquals(expected.strip(), result.strip());
+    }
+
+    @Test
+    public void writeRecordWithOnlyParameterJavadoc() throws IOException {
+        RecordDef recordDef = RecordDef.builder("test.TestRecord")
+            .addProperty(PropertyDef.builder("name").ofType(String.class)
+                .addJavadoc("The person's name").build())
+            .build();
+        var result = writeRecord(recordDef);
+
+        var expected = """
+        /**
+         * @param name The person's name
+         */
+        record TestRecord(
+            String name
+        ) {
+        }
+        """;
+        assertEquals(expected.strip(), result.strip());
+    }
+
     private String writeRecord(RecordDef recordDef) throws IOException {
         JavaPoetSourceGenerator generator = new JavaPoetSourceGenerator();
         String result;
@@ -55,8 +104,8 @@ private String writeRecord(RecordDef recordDef) throws IOException {
         }
 
         // The regex will skip the imports and make sure it is a record
-        final Pattern RECORD_REGEX = Pattern.compile("package [^;]+;[\\s\\S]+" +
-            "(record \\S+[\\s\\S]+})\\s*");
+        final Pattern RECORD_REGEX = Pattern.compile("package [^;]+;[^/]+" +
+            "((?:/\\*\\*[\\S\\s]+\\*/\\s+|)record \\S+[\\s\\S]+})\\s*");
         Matcher matcher = RECORD_REGEX.matcher(result);
         if (!matcher.matches()) {
             fail("Expected record to match regex: \n" + RECORD_REGEX + "\nbut is: \n" + result);