Flag to enable experimental KDoc resolution

Author: AbdullinAM

dokka-subprojects/analysis-kotlin-symbols/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/symbols/plugin/InternalConfiguration.kt

@@ -8,6 +8,8 @@ package org.jetbrains.dokka.analysis.kotlin.symbols.plugin
 internal object InternalConfiguration {
     private const val ALLOW_KOTLIN_PACKAGE_PROPERTY = "org.jetbrains.dokka.analysis.allowKotlinPackage"
 
+    private const val ENABLE_EXPERIMENTAL_KDOC_RESOLUTION = "org.jetbrains.dokka.analysis.enableExperimentalKDocResolution"
+
     /**
      * Allow analysing code in the 'kotlin' package
      *
@@ -18,6 +20,14 @@ internal object InternalConfiguration {
     val allowKotlinPackage: Boolean
         get() = getBooleanProperty(ALLOW_KOTLIN_PACKAGE_PROPERTY)
 
+    /**
+     * Enable experimental KDoc resolution
+     *
+     * Default: false
+     */
+    val experimentalKDocResolutionEnabled: Boolean
+        get() = getBooleanProperty(ENABLE_EXPERIMENTAL_KDOC_RESOLUTION)
+
     private fun getBooleanProperty(propertyName: String): Boolean {
         return System.getProperty(propertyName) in setOf("1", "true")
     }

dokka-subprojects/analysis-kotlin-symbols/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/symbols/plugin/KotlinAnalysis.kt

@@ -28,10 +28,6 @@ import org.jetbrains.kotlin.platform.jvm.JvmPlatforms
 import org.jetbrains.kotlin.platform.konan.NativePlatforms
 import org.jetbrains.kotlin.platform.wasm.WasmPlatforms
 import java.io.File
-import java.io.IOException
-import java.nio.file.*
-import java.nio.file.attribute.BasicFileAttributes
-import kotlin.io.path.extension
 
 internal fun Platform.toTargetPlatform() = when (this) {
     Platform.wasm -> WasmPlatforms.unspecifiedWasmPlatform
@@ -80,7 +76,9 @@ internal fun createAnalysisSession(
     projectDisposable: Disposable = Disposer.newDisposable("StandaloneAnalysisAPISession.project"),
     isSampleProject: Boolean = false
 ): KotlinAnalysis {
-    enableExperimentalKDocResolution()
+    if (InternalConfiguration.experimentalKDocResolutionEnabled) {
+        enableExperimentalKDocResolution()
+    }
 
     val sourcesModule = mutableMapOf<DokkaConfiguration.DokkaSourceSet, KaSourceModule>()
     val isMultiplatformProject = sourceSets.any { it.analysisPlatform != Platform.jvm }

dokka-subprojects/plugin-base/src/test/kotlin/content/kdoc/KDocAmbiguityResolutionTest.kt

@@ -29,6 +29,7 @@ import org.jetbrains.dokka.pages.ContentPage
 import org.jetbrains.dokka.pages.MemberPageNode
 import utils.OnlySymbols
 import utils.findTestType
+import utils.withExperimentalKDocResolution
 import kotlin.test.Ignore
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -46,7 +47,7 @@ class KDocAmbiguityResolutionTest : BaseAbstractTest() {
     }
 
     @Test
-    fun `#3451 ambiguous link to the class`() {
+    fun `#3451 ambiguous link to the class`() = withExperimentalKDocResolution {
         testInline(
             """
             |/src/main/kotlin/test/source.kt
@@ -120,7 +121,7 @@ class KDocAmbiguityResolutionTest : BaseAbstractTest() {
     }
 
     @Test
-    fun `#3451 ambiguous link to function and property`() {
+    fun `#3451 ambiguous link to function and property`() = withExperimentalKDocResolution {
         testInline(
             """
             |/src/main/kotlin/test/source.kt
@@ -212,7 +213,7 @@ class KDocAmbiguityResolutionTest : BaseAbstractTest() {
     }
 
     @Test
-    fun `#3451 ambiguous link with factory functions`() {
+    fun `#3451 ambiguous link with factory functions`() = withExperimentalKDocResolution {
         testInline(
             """
             |/src/main/kotlin/test/source.kt
@@ -359,7 +360,7 @@ class KDocAmbiguityResolutionTest : BaseAbstractTest() {
     }
 
     @Test
-    fun `#3451 ambiguous link to inner class`() {
+    fun `#3451 ambiguous link to inner class`() = withExperimentalKDocResolution {
         testInline(
             """
             |/src/main/kotlin/test/source.kt
@@ -411,7 +412,7 @@ class KDocAmbiguityResolutionTest : BaseAbstractTest() {
     }
 
     @Test
-    fun `#3179 KDoc link to property`() {
+    fun `#3179 KDoc link to property`() = withExperimentalKDocResolution {
         testInline(
             """
             |/src/main/kotlin/test/source.kt
@@ -485,7 +486,7 @@ class KDocAmbiguityResolutionTest : BaseAbstractTest() {
     }
 
     @Test
-    fun `#3179 KDoc link to parameter`() {
+    fun `#3179 KDoc link to parameter`() = withExperimentalKDocResolution {
         testInline(
             """
             |/src/main/kotlin/test/source.kt
@@ -536,7 +537,7 @@ class KDocAmbiguityResolutionTest : BaseAbstractTest() {
 
     @Test
     @Ignore("KT-83152 [Analysis API, KDoc] Make class name links on constructors point to the class")
-    fun `#3604 KDoc reference to class from constructor`() {
+    fun `#3604 KDoc reference to class from constructor`() = withExperimentalKDocResolution {
         testInline(
             """
             |/src/main/kotlin/test/source.kt
@@ -604,7 +605,7 @@ class KDocAmbiguityResolutionTest : BaseAbstractTest() {
     }
 
     @Test
-    fun `#3632 KDoc reference to extension`() {
+    fun `#3632 KDoc reference to extension`() = withExperimentalKDocResolution {
         testInline(
             """
             |/src/main/kotlin/test/source.kt
@@ -666,7 +667,7 @@ class KDocAmbiguityResolutionTest : BaseAbstractTest() {
     }
 
     @Test
-    fun `#3632 KDoc reference to member in extension`() {
+    fun `#3632 KDoc reference to member in extension`() = withExperimentalKDocResolution {
         testInline(
             """
             |/src/main/kotlin/test/source.kt
@@ -726,7 +727,7 @@ class KDocAmbiguityResolutionTest : BaseAbstractTest() {
     }
 
     @Test
-    fun `#4327 KDoc reference to properties named the same as constructor parameters`() {
+    fun `#4327 KDoc reference to properties named the same as constructor parameters`() = withExperimentalKDocResolution {
         testInline(
             """
             |/src/main/kotlin/test/source.kt

dokka-subprojects/plugin-base/src/test/kotlin/utils/systemProperties.kt

@@ -21,6 +21,13 @@ internal fun withSinceKotlin(block: () -> Unit): Unit =
 internal fun withAllowKotlinPackage(block: () -> Unit): Unit =
     DokkaBaseInternalConfiguration.withProperty("org.jetbrains.dokka.analysis.allowKotlinPackage", "true", block)
 
+/**
+ * This property works only for K2
+ * Enable experimental KDoc resolution
+ */
+internal fun withExperimentalKDocResolution(block: () -> Unit): Unit =
+    DokkaBaseInternalConfiguration.withProperty("org.jetbrains.dokka.analysis.enableExperimentalKDocResolution", "true", block)
+
 internal fun DokkaBaseInternalConfiguration.withProperty(propertyName: String, value: String, block: () -> Unit) {
     setProperty(propertyName, value)
     try {