Set 'protected' modifier as allowed

detekt · Apr 28, 2022 · b86ae6f · b86ae6f
1 parent b8700b6
commit b86ae6f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/...kotlin/io/gitlab/arturbosch/detekt/rules/documentation/KDocReferencesNonPublicProperty.kt b/...kotlin/io/gitlab/arturbosch/detekt/rules/documentation/KDocReferencesNonPublicProperty.kt
@@ -13,6 +13,7 @@ import org.jetbrains.kotlin.psi.KtObjectDeclaration
 import org.jetbrains.kotlin.psi.KtProperty
 import org.jetbrains.kotlin.psi.psiUtil.containingClassOrObject
 import org.jetbrains.kotlin.psi.psiUtil.getTopmostParentOfType
+import org.jetbrains.kotlin.psi.psiUtil.isProtected
 import org.jetbrains.kotlin.psi.psiUtil.isPublic
 
 /**
@@ -66,12 +67,12 @@ class KDocReferencesNonPublicProperty(config: Config = Config.empty) : Rule(conf
     }
 
     private fun KtProperty.isNonPublicInherited(): Boolean {
-        if (!isPublic) {
+        if (!isPublic && !isProtected()) {
             return true
         }
         var classOrObject = containingClassOrObject
         while (classOrObject != null && classOrObject is KtObjectDeclaration) {
-            if (!classOrObject.isPublic) {
+            if (!classOrObject.isPublic && !isProtected()) {
                 return true
             }
             classOrObject = classOrObject.containingClassOrObject

diff --git a/...in/io/gitlab/arturbosch/detekt/rules/documentation/KDocReferencesNonPublicPropertySpec.kt b/...in/io/gitlab/arturbosch/detekt/rules/documentation/KDocReferencesNonPublicPropertySpec.kt
@@ -78,8 +78,8 @@ class KDocReferencesNonPublicPropertySpec {
              * [A.B.prop2] - public property
              * [C.prop3] - public property
              */
-            class Test {
-                val prop1 = 0
+            open class Test {
+                protected val prop1 = 0
                 object A {
                     object B {
                         val prop2 = 0