[Analysis API, KDoc] Prioritize ClassLikeSymbols in KDoc

KDoc analysis only picks the first KaSymbol in the returned collection to display to users, so it's only required to sort the resulting collection ^KT-64190 fixed
JetBrains · Oct 5, 2024 · 6d375cf · 6d375cf
1 parent fa3a3db
commit 6d375cf
Show file tree

Hide file tree

Showing 17 changed files with 85 additions and 1 deletion.
diff --git a/.../cases/components/resolver/Fe10IdeNormalAnalysisSourceModuleResolveCallTestGenerated.java b/.../cases/components/resolver/Fe10IdeNormalAnalysisSourceModuleResolveCallTestGenerated.java
diff --git a/.../components/resolver/Fe10IdeNormalAnalysisSourceModuleResolveCandidatesTestGenerated.java b/.../components/resolver/Fe10IdeNormalAnalysisSourceModuleResolveCandidatesTestGenerated.java
diff --git a/...s/components/resolver/Fe10IdeNormalAnalysisSourceModuleResolveReferenceTestGenerated.java b/...s/components/resolver/Fe10IdeNormalAnalysisSourceModuleResolveReferenceTestGenerated.java
diff --git a/...sis-api-fir/src/org/jetbrains/kotlin/analysis/api/fir/references/KDocReferenceResolver.kt b/...sis-api-fir/src/org/jetbrains/kotlin/analysis/api/fir/references/KDocReferenceResolver.kt
@@ -71,7 +71,8 @@ internal object KDocReferenceResolver {
             //ensure file context is provided for "non-physical" code as well
             val contextDeclarationOrSelf = PsiTreeUtil.getContextOfType(contextElement, KtDeclaration::class.java, false)
                 ?: contextElement
-            val fullSymbolsResolved = resolveKdocFqName(fullFqName, contextDeclarationOrSelf)
+            val fullSymbolsResolved =
+                resolveKdocFqName(fullFqName, contextDeclarationOrSelf).sortedByDescending { it.symbol is KaClassLikeSymbol }
             if (selectedFqName == fullFqName) return fullSymbolsResolved.mapTo(mutableSetOf()) { it.symbol }
             if (fullSymbolsResolved.isEmpty()) {
                 val parent = fullFqName.parent()

diff --git a/.../components/resolver/FirIdeNormalAnalysisLibrarySourceModuleResolveCallTestGenerated.java b/.../components/resolver/FirIdeNormalAnalysisLibrarySourceModuleResolveCallTestGenerated.java
diff --git a/...nents/resolver/FirIdeNormalAnalysisLibrarySourceModuleResolveCandidatesTestGenerated.java b/...nents/resolver/FirIdeNormalAnalysisLibrarySourceModuleResolveCandidatesTestGenerated.java
diff --git a/...onents/resolver/FirIdeNormalAnalysisLibrarySourceModuleResolveReferenceTestGenerated.java b/...onents/resolver/FirIdeNormalAnalysisLibrarySourceModuleResolveReferenceTestGenerated.java
diff --git a/...d/cases/components/resolver/FirIdeNormalAnalysisSourceModuleResolveCallTestGenerated.java b/...d/cases/components/resolver/FirIdeNormalAnalysisSourceModuleResolveCallTestGenerated.java
diff --git a/...s/components/resolver/FirIdeNormalAnalysisSourceModuleResolveCandidatesTestGenerated.java b/...s/components/resolver/FirIdeNormalAnalysisSourceModuleResolveCandidatesTestGenerated.java
diff --git a/...es/components/resolver/FirIdeNormalAnalysisSourceModuleResolveReferenceTestGenerated.java b/...es/components/resolver/FirIdeNormalAnalysisSourceModuleResolveReferenceTestGenerated.java
diff --git a/.../components/resolver/FirStandaloneNormalAnalysisSourceModuleResolveCallTestGenerated.java b/.../components/resolver/FirStandaloneNormalAnalysisSourceModuleResolveCallTestGenerated.java
diff --git a/...nents/resolver/FirStandaloneNormalAnalysisSourceModuleResolveCandidatesTestGenerated.java b/...nents/resolver/FirStandaloneNormalAnalysisSourceModuleResolveCandidatesTestGenerated.java
diff --git a/...onents/resolver/FirStandaloneNormalAnalysisSourceModuleResolveReferenceTestGenerated.java b/...onents/resolver/FirStandaloneNormalAnalysisSourceModuleResolveReferenceTestGenerated.java
diff --git a/...ysis/analysis-api/testData/components/resolver/singleByPsi/kDoc/imports/KT-64190.call.txt b/...ysis/analysis-api/testData/components/resolver/singleByPsi/kDoc/imports/KT-64190.call.txt
@@ -0,0 +1,2 @@
+KtNamedFunction(0,32): '/**'
+  null
diff --git a/...nalysis-api/testData/components/resolver/singleByPsi/kDoc/imports/KT-64190.candidates.txt b/...nalysis-api/testData/components/resolver/singleByPsi/kDoc/imports/KT-64190.candidates.txt
@@ -0,0 +1,2 @@
+KtNamedFunction(0,32): '/**'
+  NO_CANDIDATES
diff --git a/analysis/analysis-api/testData/components/resolver/singleByPsi/kDoc/imports/KT-64190.kt b/analysis/analysis-api/testData/components/resolver/singleByPsi/kDoc/imports/KT-64190.kt
@@ -0,0 +1,4 @@
+/**
+* ref to [<caret>List]
+*/
+fun x(){}
diff --git a/...nalysis-api/testData/components/resolver/singleByPsi/kDoc/imports/KT-64190.references.txt b/...nalysis-api/testData/components/resolver/singleByPsi/kDoc/imports/KT-64190.references.txt
@@ -0,0 +1,3 @@
+KDocName(14,18): 'List'
+  KDocReference:
+    (in kotlin.collections) interface List<out E> : kotlin.collections.Collection<E>