From 0e00edc6fcd406fcf38673ef6a2f8f59e8374de2 Mon Sep 17 00:00:00 2001
From: Vadim Mishenev <vad-mishenev@yandex.ru>
Date: Mon, 28 Aug 2023 19:42:21 +0300
Subject:  Support Dokka K2 analysis (#3094)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Dokka has its own documentable model to represent analyzed code. The analysis is performed by a compiler frontend.

In K1 the compiler frontend has descriptors that use the underlying Binding Context (global shared stateful structure). Dokka just maps descriptors to Documentable by DefaultDescriptorToDocumentableTranslator.

K2 compiler has FIR tree, which means “Frontend Intermediate Representation”, instead of Binding Context. But we do not use FIR in Dokka directly, since it is too low-level for analysis. The Kotlin compiler provides high-level Analysis API for this case. The API is used by KSP too. Analysis API represent elements of FIR (declarations, parameters and so on) as Symbols. For more details see KtSymbolByFirBuilder, KtSymbol.
For Dokka symbol is the replacement of descriptor in K2.

Also, to set up the environment of project analysis in K1 we use idea dependencies (or copy-past from there). In K2 for these aims, there is a Standalone mode for Analysis API.
---
 subprojects/analysis-kotlin-symbols/ide/api/ide.api         |  4 ----
 subprojects/analysis-kotlin-symbols/ide/build.gradle.kts    | 13 -------------
 .../analysis/kotlin/symbols/ide/IdeSymbolsAnalysisPlugin.kt | 11 -----------
 .../services/org.jetbrains.dokka.plugability.DokkaPlugin    |  1 -
 4 files changed, 29 deletions(-)
 delete mode 100644 subprojects/analysis-kotlin-symbols/ide/api/ide.api
 delete mode 100644 subprojects/analysis-kotlin-symbols/ide/build.gradle.kts
 delete mode 100644 subprojects/analysis-kotlin-symbols/ide/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/symbols/ide/IdeSymbolsAnalysisPlugin.kt
 delete mode 100644 subprojects/analysis-kotlin-symbols/ide/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin

(limited to 'subprojects/analysis-kotlin-symbols/ide')

diff --git a/subprojects/analysis-kotlin-symbols/ide/api/ide.api b/subprojects/analysis-kotlin-symbols/ide/api/ide.api
deleted file mode 100644
index 9be46c0b..00000000
--- a/subprojects/analysis-kotlin-symbols/ide/api/ide.api
+++ /dev/null
@@ -1,4 +0,0 @@
-public final class org/jetbrains/dokka/analysis/kotlin/symbols/ide/IdeSymbolsAnalysisPlugin : org/jetbrains/dokka/plugability/DokkaPlugin {
-	public fun <init> ()V
-}
-
diff --git a/subprojects/analysis-kotlin-symbols/ide/build.gradle.kts b/subprojects/analysis-kotlin-symbols/ide/build.gradle.kts
deleted file mode 100644
index 876d87ca..00000000
--- a/subprojects/analysis-kotlin-symbols/ide/build.gradle.kts
+++ /dev/null
@@ -1,13 +0,0 @@
-plugins {
-    id("org.jetbrains.conventions.kotlin-jvm")
-}
-
-dependencies {
-    compileOnly(projects.core)
-    compileOnly(projects.subprojects.analysisKotlinApi)
-
-    // TODO
-
-    // TODO [beresnev] get rid of it
-    compileOnly(libs.kotlinx.coroutines.core)
-}
diff --git a/subprojects/analysis-kotlin-symbols/ide/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/symbols/ide/IdeSymbolsAnalysisPlugin.kt b/subprojects/analysis-kotlin-symbols/ide/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/symbols/ide/IdeSymbolsAnalysisPlugin.kt
deleted file mode 100644
index 33f555cb..00000000
--- a/subprojects/analysis-kotlin-symbols/ide/src/main/kotlin/org/jetbrains/dokka/analysis/kotlin/symbols/ide/IdeSymbolsAnalysisPlugin.kt
+++ /dev/null
@@ -1,11 +0,0 @@
-package org.jetbrains.dokka.analysis.kotlin.symbols.ide
-
-import org.jetbrains.dokka.plugability.DokkaPlugin
-import org.jetbrains.dokka.plugability.DokkaPluginApiPreview
-import org.jetbrains.dokka.plugability.PluginApiPreviewAcknowledgement
-
-class IdeSymbolsAnalysisPlugin : DokkaPlugin() {
-
-    @OptIn(DokkaPluginApiPreview::class)
-    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement = PluginApiPreviewAcknowledgement
-}
diff --git a/subprojects/analysis-kotlin-symbols/ide/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin b/subprojects/analysis-kotlin-symbols/ide/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin
deleted file mode 100644
index 59245578..00000000
--- a/subprojects/analysis-kotlin-symbols/ide/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin
+++ /dev/null
@@ -1 +0,0 @@
-org.jetbrains.dokka.analysis.kotlin.symbols.ide.IdeSymbolsAnalysisPlugin
-- 
cgit