From 66887db42e51805ce91dff71fcd01f422664bf87 Mon Sep 17 00:00:00 2001 From: Dmitry Jemerov Date: Wed, 4 Feb 2015 18:17:07 +0100 Subject: [PATCH] highlight unresolved references in KDoc --- .../kotlin/idea/kdoc/KDocReference.kt | 2 + .../kdoc/KDocUnresolvedReferenceInspection.kt | 39 +++++++++++++++++++ idea/src/META-INF/plugin.xml | 8 +++- 3 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 idea/idea-analysis/src/org/jetbrains/kotlin/idea/kdoc/KDocUnresolvedReferenceInspection.kt diff --git a/idea/idea-analysis/src/org/jetbrains/kotlin/idea/kdoc/KDocReference.kt b/idea/idea-analysis/src/org/jetbrains/kotlin/idea/kdoc/KDocReference.kt index 5b29fa98ae8..b2256652453 100644 --- a/idea/idea-analysis/src/org/jetbrains/kotlin/idea/kdoc/KDocReference.kt +++ b/idea/idea-analysis/src/org/jetbrains/kotlin/idea/kdoc/KDocReference.kt @@ -70,6 +70,8 @@ public class KDocReference(element: KDocName): JetMultiReference(eleme val newLink = KDocElementFactory(getElement().getProject()).createNameFromText(newText) return getElement().replace(newLink) } + + override fun getCanonicalText(): String = getElement().getNameText() } public fun resolveKDocLink(session: KotlinCodeAnalyzer, diff --git a/idea/idea-analysis/src/org/jetbrains/kotlin/idea/kdoc/KDocUnresolvedReferenceInspection.kt b/idea/idea-analysis/src/org/jetbrains/kotlin/idea/kdoc/KDocUnresolvedReferenceInspection.kt new file mode 100644 index 00000000000..cede495a1a0 --- /dev/null +++ b/idea/idea-analysis/src/org/jetbrains/kotlin/idea/kdoc/KDocUnresolvedReferenceInspection.kt @@ -0,0 +1,39 @@ +/* + * Copyright 2010-2015 JetBrains s.r.o. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.jetbrains.kotlin.idea.kdoc + +import org.jetbrains.kotlin.idea.inspections.AbstractKotlinInspection +import com.intellij.codeInspection.ProblemsHolder +import com.intellij.psi.PsiElementVisitor +import com.intellij.psi.PsiElement +import org.jetbrains.kotlin.kdoc.psi.impl.KDocName + +public class KDocUnresolvedReferenceInspection(): AbstractKotlinInspection() { + override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor = + KDocUnresolvedReferenceVisitor(holder) + + private class KDocUnresolvedReferenceVisitor(private val holder: ProblemsHolder): PsiElementVisitor() { + override fun visitElement(element: PsiElement) { + if (element is KDocName) { + val ref = element.getReference() + if (ref != null && ref.resolve() == null) { + holder.registerProblem(ref) + } + } + } + } +} diff --git a/idea/src/META-INF/plugin.xml b/idea/src/META-INF/plugin.xml index e2992bda0ae..e6040c9003f 100644 --- a/idea/src/META-INF/plugin.xml +++ b/idea/src/META-INF/plugin.xml @@ -832,7 +832,13 @@ enabledByDefault="true" level="WARNING" /> - + +