azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Correctly detect visibility in KDocMissingDocumentationInspection

Browse Source 
#KT-20887 fixed
 #KT-20889 fixed
This commit is contained in:
Simon Ogorodnik
2017-10-23 02:21:02 +03:00
parent f21e1c60e0
commit fb876e398c
2 changed files with 28 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
idea/src/org/jetbrains/kotlin/idea/inspections/kdoc/KDocMissingDocumentationInspection.kt
+8 -9
View File
@@ -24,23 +24,23 @@ import com.intellij.openapi.project.Project
import com.intellij.psi.PsiElement
import com.intellij.psi.PsiElementVisitor
import com.intellij.psi.impl.source.PostprocessReformattingAspect
import org.jetbrains.kotlin.descriptors.CallableMemberDescriptor
import org.jetbrains.kotlin.descriptors.DeclarationDescriptorWithVisibility
import org.jetbrains.kotlin.descriptors.MemberDescriptor
import org.jetbrains.kotlin.descriptors.Visibilities
import org.jetbrains.kotlin.idea.caches.resolve.resolveToDescriptorIfAny
import org.jetbrains.kotlin.idea.core.unblockDocument
import org.jetbrains.kotlin.idea.inspections.AbstractKotlinInspection
import org.jetbrains.kotlin.idea.inspections.describe
import org.jetbrains.kotlin.idea.inspections.findExistingEditor
import org.jetbrains.kotlin.idea.kdoc.KDocElementFactory
import org.jetbrains.kotlin.idea.kdoc.findKDoc
import org.jetbrains.kotlin.kdoc.psi.impl.KDocSection
import org.jetbrains.kotlin.psi.KtNamedDeclaration
import org.jetbrains.kotlin.psi.KtPsiFactory
import org.jetbrains.kotlin.psi.psiUtil.endOffset
import org.jetbrains.kotlin.psi.psiUtil.getChildOfType
import org.jetbrains.kotlin.psi.psiUtil.getParentOfType
import org.jetbrains.kotlin.resolve.descriptorUtil.isEffectivelyPublicApi
import org.jetbrains.kotlin.resolve.lazy.BodyResolveMode
import org.jetbrains.kotlin.resolve.source.getPsi
class KDocMissingDocumentationInspection() : AbstractKotlinInspection() {
override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor =
@@ -51,12 +51,11 @@ class KDocMissingDocumentationInspection() : AbstractKotlinInspection() {
if (element is KtNamedDeclaration) {
val nameIdentifier = element.nameIdentifier
val descriptor = element.resolveToDescriptorIfAny(BodyResolveMode.FULL) as? MemberDescriptor
if (nameIdentifier != null && descriptor?.visibility == Visibilities.PUBLIC) {
val hasDocumentation = element.docComment != null ||
(descriptor as? CallableMemberDescriptor)?.overriddenDescriptors
?.any { (it.source.getPsi() as? KtNamedDeclaration)?.docComment != null } ?: false
if (!hasDocumentation) {
val descriptor = element.resolveToDescriptorIfAny(BodyResolveMode.FULL)
as? DeclarationDescriptorWithVisibility
as? MemberDescriptor ?: return
if (nameIdentifier != null && descriptor.isEffectivelyPublicApi) {
if (descriptor.findKDoc() == null) {
val message = element.describe()?.let { "$it is missing documentation" } ?: "Missing documentation"
holder.registerProblem(nameIdentifier, message, AddDocumentationFix())
}
idea/testData/kdoc/highlighting/MissingDocumentation.kt
Vendored
+20 -9
View File
@@ -1,6 +1,6 @@
public fun <warning descr="Missing documentation">publicUndocumentedFun</warning>() {}
fun <warning descr="Missing documentation">defaultUndocumentedFun</warning>() {}
public fun <warning descr="Function ''publicUndocumentedFun'' is missing documentation">publicUndocumentedFun</warning>() {}
fun <warning descr="Function ''defaultUndocumentedFun'' is missing documentation">defaultUndocumentedFun</warning>() {}
/** Some documentation */
public fun publicDocumentedFun() {}
@@ -13,8 +13,8 @@ internal fun internalUndocumentedFun() {}
public class <warning descr="Missing documentation">publicUndocumentedClass</warning>() {}
class <warning descr="Missing documentation">defaultUndocumentedClass</warning>() {}
public class <warning descr="Class ''publicUndocumentedClass'' is missing documentation">publicUndocumentedClass</warning>() {}
class <warning descr="Class ''defaultUndocumentedClass'' is missing documentation">defaultUndocumentedClass</warning>() {}
/** Some documentation */
public class publicDocumentedClass() {}
@@ -29,8 +29,8 @@ internal class internalUndocumentedClass() {}
private open class Properties {
public open val <warning descr="Missing documentation">publicUndocumentedProperty</warning>: Int = 0
open val <warning descr="Missing documentation">defaultUndocumentedProperty</warning>: Int = 0
public open val publicUndocumentedProperty: Int = 0
open val defaultUndocumentedProperty: Int = 0
/** Some documentation */
public open val publicDocumentedProperty: Int = 0
@@ -51,14 +51,14 @@ private open class Properties {
}
private open class ChildClass : Properties() {
override val <warning descr="Missing documentation">publicUndocumentedProperty</warning>: Int = 4
override val <warning descr="Missing documentation">defaultUndocumentedProperty</warning>: Int = 4
override val publicUndocumentedProperty: Int = 4
override val defaultUndocumentedProperty: Int = 4
override val publicDocumentedProperty: Int = 4
override val defaultDocumentedProperty: Int = 4
/** Some documentation */
override public val internalUndocumentedProperty: Int = 4
override public val <warning descr="Missing documentation">protectedUndocumentedProperty</warning>: Int = 4
override public val protectedUndocumentedProperty: Int = 4
override public val protectedDocumentedProperty: Int = 4
}
@@ -66,4 +66,15 @@ private class GrandChildClass : ChildClass() {
override public val internalUndocumentedProperty: Int = 6
}
open class <warning descr="Class ''SomeClass'' is missing documentation">SomeClass</warning> {
protected fun <warning descr="Function ''testProtected'' is missing documentation">testProtected</warning>() = 1
}
class <warning descr="Class ''FinalClassWithProtected'' is missing documentation">FinalClassWithProtected</warning> {
protected fun <warning descr="Function ''testProtected'' is missing documentation">testProtected</warning>() = 1
}
private class PrimaryCon(val p: String)
// NO_CHECK_INFOS