Some fixes

Author: kiryldz

README.md

@@ -28,8 +28,8 @@ And you will have to include the required dependencies:
 
 ```groovy
 dependencies {
-  implementation 'com.github.tobrun.kotlin-data-compat:annotation:0.5.1'
-  ksp 'com.github.tobrun.kotlin-data-compat:processor:0.5.1'
+  implementation 'com.github.tobrun.kotlin-data-compat:annotation:0.5.2'
+  ksp 'com.github.tobrun.kotlin-data-compat:processor:0.5.2'
 }
 ```
 
@@ -62,6 +62,9 @@ annotation class SampleAnnotation
 private data class PersonData(
     @Default("\"John\" + Date(1580897313933L).toString()")
     val name: String,
+    /**
+     * Additional comment.
+     */
     val nickname: String?,
     @Default("42")
     val age: Int
@@ -90,20 +93,39 @@ import kotlin.jvm.JvmSynthetic
  */
 @SampleAnnotation
 public class Person private constructor(
+    /**
+     * The full name.
+     */
     public val name: String,
+    /**
+     * The nickname.
+     * Additional comment.
+     */
     public val nickname: String?,
+    /**
+     * The age.
+     */
     public val age: Int
 ) : SampleInterface {
+    /**
+     * Overloaded toString function.
+     */
     public override fun toString() = """Person(name=$name, nickname=$nickname,
       age=$age)""".trimIndent()
 
+    /**
+     * Overloaded equals function.
+     */
     public override fun equals(other: Any?): Boolean {
         if (this === other) return true
         if (javaClass != other?.javaClass) return false
         other as Person
         return name == other.name && nickname == other.nickname && age == other.age
     }
 
+    /**
+     * Overloaded hashCode function based on all class properties.
+     */
     public override fun hashCode(): Int = Objects.hash(name, nickname, age)
 
     /**
@@ -121,12 +143,22 @@ public class Person private constructor(
      * @property age The age.
      */
     public class Builder {
+        /**
+         * The full name.
+         */
         @set:JvmSynthetic
         public var name: String? = "John" + Date(1580897313933L).toString()
 
+        /**
+         * The nickname.
+         * Additional comment.
+         */
         @set:JvmSynthetic
         public var nickname: String? = null
 
+        /**
+         * The age.
+         */
         @set:JvmSynthetic
         public var age: Int? = 42
 
@@ -143,6 +175,7 @@ public class Person private constructor(
 
         /**
          * Set the nickname.
+         * Additional comment.
          *
          * @param nickname the nickname.
          * @return Builder

example/src/main/kotlin/com/tobrun/data/compat/example/PersonData.kt

@@ -17,6 +17,9 @@ annotation class SampleAnnotation
 private data class PersonData(
     @Default("\"John\" + Date(1580897313933L).toString()")
     val name: String,
+    /**
+     * Additional comment.
+     */
     val nickname: String?,
     @Default("42")
     val age: Int

processor/src/main/kotlin/com/tobrun/datacompat/DataCompatProcessor.kt

@@ -184,8 +184,13 @@ class DataCompatProcessor(
                         PropertySpec.builder(entry.key.toString(), entry.value)
                             .addKdoc(
                                 """
-                            |Represents ${getKDocProperty(kdocPropertyList, entry.key.toString())}
-                            """.trimMargin()
+                                |${getKDocProperty(kdocPropertyList, entry.key.toString()).replaceFirstChar {
+                                    if (it.isLowerCase()) it.titlecase(
+                                        Locale.getDefault()
+                                    ) else it.toString()
+                                }}
+                                |${entry.key.docString?.trimStart(' ', '\n') ?: ""}
+                                """.trimMargin()
                             )
                             .initializer(entry.key.toString())
                             .build()
@@ -217,8 +222,8 @@ class DataCompatProcessor(
                     .addModifiers(KModifier.OVERRIDE)
                     .addKdoc(
                         """
-                            Overloaded equals function.
-                            """.trimIndent()
+                        Overloaded equals function.
+                        """.trimIndent()
                     )
                     .addParameter("other", ANY.copy(nullable = true))
                     .addStatement("if (this === other) return true")
@@ -296,7 +301,12 @@ class DataCompatProcessor(
                         )
                         .addKdoc(
                             """
-                            |Represents $kDocProperty
+                            |${kDocProperty.replaceFirstChar {
+                                if (it.isLowerCase()) it.titlecase(
+                                    Locale.getDefault()
+                                ) else it.toString()
+                            }}
+                            |${property.key.docString?.trimStart(' ', '\n') ?: ""}
                             """.trimMargin()
                         )
                         .addAnnotation(
@@ -318,7 +328,7 @@ class DataCompatProcessor(
                         .addKdoc(
                             """
                             |Set $kDocProperty
-                            |
+                            |${property.key.docString?.trimStart(' ', '\n') ?: ""}
                             |@param $propertyName $kDocProperty
                             |@return Builder
                             """.trimMargin()

processor/src/test/kotlin/com/tobrun/datacompat/DataCompatProcessorTest.kt

@@ -34,6 +34,9 @@ private data class PersonData(
     val nickname: String?,
     @Default("23")
     val age: Int,
+    /**
+     * Actually it's a very short description.
+    */
     val veryLongAndVeryDetailedDescription: String?
 ) : EmptyInterface, EmptyInterface2
     """.trimIndent()