Allow inline comments for properties in primary constructor as docume…

…ntation (detekt#3722) * Allow inline comments for properties in primary constructor Fixes detekt#3677 * Revert blank line removal in UndocumentedPublicProperty * - remove configuration - update tests * - remove unused import
chao2zhang · May 13, 2021 · 55d4059 · 55d4059
1 parent b8871b9
commit 55d4059
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/...main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/UndocumentedPublicProperty.kt b/...main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/UndocumentedPublicProperty.kt
@@ -36,7 +36,8 @@ class UndocumentedPublicProperty(config: Config = Config.empty) : Rule(config) {
         if (constructor.isPublicInherited()) {
             val comment = constructor.containingClassOrObject?.docComment?.text
             constructor.valueParameters
-                .filter { it.isPublicNotOverridden() && it.hasValOrVar() && it.isUndocumented(comment) }
+                .filter { it.isPublicNotOverridden() && it.hasValOrVar() }
+                .filter { it.isUndocumented(comment) && it.docComment == null }
                 .forEach { report(it) }
         }
         super.visitPrimaryConstructor(constructor)

diff --git a/.../kotlin/io/gitlab/arturbosch/detekt/rules/documentation/UndocumentedPublicPropertySpec.kt b/.../kotlin/io/gitlab/arturbosch/detekt/rules/documentation/UndocumentedPublicPropertySpec.kt
@@ -144,7 +144,16 @@ class UndocumentedPublicPropertySpec : Spek({
                 * @property [c] int3
                 * @param d int4
                 */
-                class Test(val a: Int, val b: Int, val c: Int, val d: Int)
+                class Test(
+                    val a: Int, 
+                    val b: Int, 
+                    val c: Int, 
+                    val d: Int,
+                    /**
+                     * Some docs.
+                     */
+                    val e: Int                    
+                )
             """
             assertThat(subject.compileAndLint(code)).isEmpty()
         }