Remove superfluous newline

square · Nov 18, 2023 · e0911f8 · e0911f8
1 parent 6e302a9
commit e0911f8
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 6 deletions.
diff --git a/kotlinpoet/src/commonMain/kotlin/com/squareup/kotlinpoet/TypeSpec.kt b/kotlinpoet/src/commonMain/kotlin/com/squareup/kotlinpoet/TypeSpec.kt
@@ -390,12 +390,16 @@ public class TypeSpec private constructor(
         parameter.kdoc != propertyKdoc
     }
     return with(kdoc.ensureEndsWithNewLine().toBuilder()) {
-      if (kdoc.isNotEmpty()) add("\n")
-      if (primaryConstructor.kdoc.isNotEmpty()) {
-        add("@constructor %L", primaryConstructor.kdoc.ensureEndsWithNewLine())
-      }
-      parametersWithKdoc.forEach { parameter ->
-        add("@param %L %L", parameter.name, parameter.kdoc.ensureEndsWithNewLine())
+      if (primaryConstructor.kdoc.isNotEmpty() || parametersWithKdoc.isNotEmpty()) {
+        if (isNotEmpty()) {
+          add("\n")
+        }
+        if (primaryConstructor.kdoc.isNotEmpty()) {
+          add("@constructor %L", primaryConstructor.kdoc.ensureEndsWithNewLine())
+        }
+        parametersWithKdoc.forEach { parameter ->
+          add("@param %L %L", parameter.name, parameter.kdoc.ensureEndsWithNewLine())
+        }
       }
       build()
     }

diff --git a/kotlinpoet/src/commonTest/kotlin/com/squareup/kotlinpoet/TypeSpecTest.kt b/kotlinpoet/src/commonTest/kotlin/com/squareup/kotlinpoet/TypeSpecTest.kt
@@ -5615,6 +5615,27 @@ class TypeSpecTest {
     )
   }
 
+  @Test fun classKdoc() {
+    val type = TypeSpec.classBuilder("MyClass")
+      .addKdoc("This is my class")
+      .primaryConstructor(
+        FunSpec.constructorBuilder()
+          .build(),
+      )
+      .build()
+
+    //language=kotlin
+    assertThat(type.toString()).isEqualTo(
+      """
+      /**
+       * This is my class
+       */
+      public class MyClass()
+
+      """.trimIndent(),
+    )
+  }
+
   // https://github.com/square/kotlinpoet/issues/1630
   @Test fun primaryConstructorKDoc() {
     val type = TypeSpec.classBuilder("MyClass")