Skip to content

Commit a09a068

Browse files
IgnatBeresnevIgnatBeresnev
committed
Reintroduce removed analysis APIs with a deprecation message (#3104)
(cherry picked from commit 0be3973)
1 parent acaac14 commit a09a068

8 files changed

+352
-0
lines changed

‎plugins/base/api/base.api

+98
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
1+
public final class org/jetbrains/dokka/analysis/AnalysisContext : java/io/Closeable {
2+
public fun <init> (Ljava/lang/Object;Ljava/lang/Object;Ljava/lang/Object;)V
3+
public fun close ()Ljava/lang/Void;
4+
public synthetic fun close ()V
5+
public final fun component1 ()Ljava/lang/Object;
6+
public final fun component2 ()Ljava/lang/Object;
7+
public final fun getEnvironment ()Ljava/lang/Object;
8+
public final fun getFacade ()Ljava/lang/Object;
9+
}
10+
11+
public final class org/jetbrains/dokka/analysis/DokkaAnalysisConfiguration {
12+
public fun <init> ()V
13+
public fun <init> (Z)V
14+
public synthetic fun <init> (ZILkotlin/jvm/internal/DefaultConstructorMarker;)V
15+
public final fun getIgnoreCommonBuiltIns ()Z
16+
}
17+
18+
public abstract class org/jetbrains/dokka/analysis/KotlinAnalysis : java/io/Closeable {
19+
public fun <init> ()V
20+
public fun <init> (Lorg/jetbrains/dokka/analysis/KotlinAnalysis;)V
21+
public synthetic fun <init> (Lorg/jetbrains/dokka/analysis/KotlinAnalysis;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
22+
protected abstract fun find (Lorg/jetbrains/dokka/DokkaSourceSetID;)Lorg/jetbrains/dokka/analysis/AnalysisContext;
23+
public final fun get (Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;)Lorg/jetbrains/dokka/analysis/AnalysisContext;
24+
public final fun get (Lorg/jetbrains/dokka/DokkaSourceSetID;)Lorg/jetbrains/dokka/analysis/AnalysisContext;
25+
}
26+
27+
public final class org/jetbrains/dokka/analysis/KotlinAnalysisDeprecatedApiKt {
28+
public static final fun KotlinAnalysis (Ljava/util/List;Lorg/jetbrains/dokka/utilities/DokkaLogger;Lorg/jetbrains/dokka/analysis/DokkaAnalysisConfiguration;)Lorg/jetbrains/dokka/analysis/KotlinAnalysis;
29+
public static final fun KotlinAnalysis (Lorg/jetbrains/dokka/plugability/DokkaContext;)Lorg/jetbrains/dokka/analysis/KotlinAnalysis;
30+
public static synthetic fun KotlinAnalysis$default (Ljava/util/List;Lorg/jetbrains/dokka/utilities/DokkaLogger;Lorg/jetbrains/dokka/analysis/DokkaAnalysisConfiguration;ILjava/lang/Object;)Lorg/jetbrains/dokka/analysis/KotlinAnalysis;
31+
public static final fun ProjectKotlinAnalysis (Ljava/util/List;Lorg/jetbrains/dokka/utilities/DokkaLogger;Lorg/jetbrains/dokka/analysis/DokkaAnalysisConfiguration;)Lorg/jetbrains/dokka/analysis/KotlinAnalysis;
32+
public static synthetic fun ProjectKotlinAnalysis$default (Ljava/util/List;Lorg/jetbrains/dokka/utilities/DokkaLogger;Lorg/jetbrains/dokka/analysis/DokkaAnalysisConfiguration;ILjava/lang/Object;)Lorg/jetbrains/dokka/analysis/KotlinAnalysis;
33+
public static final fun SamplesKotlinAnalysis (Ljava/util/List;Lorg/jetbrains/dokka/utilities/DokkaLogger;Lorg/jetbrains/dokka/analysis/KotlinAnalysis;Lorg/jetbrains/dokka/analysis/DokkaAnalysisConfiguration;)Lorg/jetbrains/dokka/analysis/KotlinAnalysis;
34+
public static synthetic fun SamplesKotlinAnalysis$default (Ljava/util/List;Lorg/jetbrains/dokka/utilities/DokkaLogger;Lorg/jetbrains/dokka/analysis/KotlinAnalysis;Lorg/jetbrains/dokka/analysis/DokkaAnalysisConfiguration;ILjava/lang/Object;)Lorg/jetbrains/dokka/analysis/KotlinAnalysis;
35+
}
36+
137
public final class org/jetbrains/dokka/base/DokkaBase : org/jetbrains/dokka/plugability/DokkaPlugin {
238
public fun <init> ()V
339
public final fun getActualTypealiasAdder ()Lorg/jetbrains/dokka/plugability/Extension;
@@ -6,7 +42,12 @@ public final class org/jetbrains/dokka/base/DokkaBase : org/jetbrains/dokka/plug
642
public final fun getCommentsToContentConverter ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
743
public final fun getCustomResourceInstaller ()Lorg/jetbrains/dokka/plugability/Extension;
844
public final fun getCustomTagContentProvider ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
45+
public final fun getDefaultExternalClasslikesTranslator ()Lorg/jetbrains/dokka/plugability/Extension;
46+
public final fun getDefaultExternalDocumentablesProvider ()Lorg/jetbrains/dokka/plugability/Extension;
47+
public final fun getDefaultKotlinAnalysis ()Lorg/jetbrains/dokka/plugability/Extension;
48+
public final fun getDefaultSamplesTransformer ()Lorg/jetbrains/dokka/plugability/Extension;
949
public final fun getDeprecatedDocumentableFilter ()Lorg/jetbrains/dokka/plugability/Extension;
50+
public final fun getDescriptorToDocumentableTranslator ()Lorg/jetbrains/dokka/plugability/Extension;
1051
public final fun getDocTagToContentConverter ()Lorg/jetbrains/dokka/plugability/Extension;
1152
public final fun getDocumentableMerger ()Lorg/jetbrains/dokka/plugability/Extension;
1253
public final fun getDocumentableToPageTranslator ()Lorg/jetbrains/dokka/plugability/Extension;
@@ -15,6 +56,8 @@ public final class org/jetbrains/dokka/base/DokkaBase : org/jetbrains/dokka/plug
1556
public final fun getEmptyModulesFilter ()Lorg/jetbrains/dokka/plugability/Extension;
1657
public final fun getEmptyPackagesFilter ()Lorg/jetbrains/dokka/plugability/Extension;
1758
public final fun getExtensionsExtractor ()Lorg/jetbrains/dokka/plugability/Extension;
59+
public final fun getExternalClasslikesTranslator ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
60+
public final fun getExternalDocumentablesProvider ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
1861
public final fun getExternalLocationProviderFactory ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
1962
public final fun getFallbackMerger ()Lorg/jetbrains/dokka/plugability/Extension;
2063
public final fun getFileWriter ()Lorg/jetbrains/dokka/plugability/Extension;
@@ -24,6 +67,7 @@ public final class org/jetbrains/dokka/base/DokkaBase : org/jetbrains/dokka/plug
2467
public final fun getInheritedEntriesVisbilityFilter ()Lorg/jetbrains/dokka/plugability/Extension;
2568
public final fun getInheritorsExtractor ()Lorg/jetbrains/dokka/plugability/Extension;
2669
public final fun getJavadocLocationProvider ()Lorg/jetbrains/dokka/plugability/Extension;
70+
public final fun getKotlinAnalysis ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
2771
public final fun getKotlinArrayDocumentableReplacer ()Lorg/jetbrains/dokka/plugability/Extension;
2872
public final fun getKotlinSignatureProvider ()Lorg/jetbrains/dokka/plugability/Extension;
2973
public final fun getLocationProvider ()Lorg/jetbrains/dokka/plugability/Extension;
@@ -37,6 +81,7 @@ public final class org/jetbrains/dokka/base/DokkaBase : org/jetbrains/dokka/plug
3781
public final fun getPageMergerStrategy ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
3882
public final fun getPathToRootConsumer ()Lorg/jetbrains/dokka/plugability/Extension;
3983
public final fun getPreMergeDocumentableTransformer ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
84+
public final fun getPsiToDocumentableTranslator ()Lorg/jetbrains/dokka/plugability/Extension;
4085
public final fun getReplaceVersionConsumer ()Lorg/jetbrains/dokka/plugability/Extension;
4186
public final fun getResolveLinkConsumer ()Lorg/jetbrains/dokka/plugability/Extension;
4287
public final fun getRootCreator ()Lorg/jetbrains/dokka/plugability/Extension;
@@ -95,6 +140,10 @@ public final class org/jetbrains/dokka/base/DokkaBaseConfiguration$Companion {
95140
public final fun getDefaultTemplatesDir ()Ljava/io/File;
96141
}
97142

143+
public final class org/jetbrains/dokka/base/deprecated/AnalysisApiDeprecatedError : java/lang/Error {
144+
public fun <init> ()V
145+
}
146+
98147
public final class org/jetbrains/dokka/base/generation/SingleModuleGeneration : org/jetbrains/dokka/generation/Generation {
99148
public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V
100149
public final fun createDocumentationModels ()Ljava/util/List;
@@ -111,6 +160,29 @@ public final class org/jetbrains/dokka/base/generation/SingleModuleGeneration :
111160
public final fun validityCheck (Lorg/jetbrains/dokka/plugability/DokkaContext;)V
112161
}
113162

163+
public class org/jetbrains/dokka/base/parsers/MarkdownParser : org/jetbrains/dokka/base/parsers/Parser {
164+
public static final field Companion Lorg/jetbrains/dokka/base/parsers/MarkdownParser$Companion;
165+
public fun <init> (Lkotlin/jvm/functions/Function1;Ljava/lang/String;)V
166+
}
167+
168+
public final class org/jetbrains/dokka/base/parsers/MarkdownParser$Companion {
169+
public final fun parseFromKDocTag (Ljava/lang/Object;Lkotlin/jvm/functions/Function1;Ljava/lang/String;Z)Lorg/jetbrains/dokka/model/doc/DocumentationNode;
170+
public static synthetic fun parseFromKDocTag$default (Lorg/jetbrains/dokka/base/parsers/MarkdownParser$Companion;Ljava/lang/Object;Lkotlin/jvm/functions/Function1;Ljava/lang/String;ZILjava/lang/Object;)Lorg/jetbrains/dokka/model/doc/DocumentationNode;
171+
}
172+
173+
public abstract class org/jetbrains/dokka/base/parsers/Parser {
174+
public fun <init> ()V
175+
public fun parseStringToDocNode (Ljava/lang/String;)Lorg/jetbrains/dokka/model/doc/DocTag;
176+
public fun parseTagWithBody (Ljava/lang/String;Ljava/lang/String;)Lorg/jetbrains/dokka/model/doc/TagWrapper;
177+
public fun preparse (Ljava/lang/String;)Ljava/lang/String;
178+
}
179+
180+
public final class org/jetbrains/dokka/base/parsers/factories/DocTagsFromStringFactory {
181+
public static final field INSTANCE Lorg/jetbrains/dokka/base/parsers/factories/DocTagsFromStringFactory;
182+
public final fun getInstance (Ljava/lang/String;Ljava/util/List;Ljava/util/Map;Ljava/lang/String;Lorg/jetbrains/dokka/links/DRI;)Lorg/jetbrains/dokka/model/doc/DocTag;
183+
public static synthetic fun getInstance$default (Lorg/jetbrains/dokka/base/parsers/factories/DocTagsFromStringFactory;Ljava/lang/String;Ljava/util/List;Ljava/util/Map;Ljava/lang/String;Lorg/jetbrains/dokka/links/DRI;ILjava/lang/Object;)Lorg/jetbrains/dokka/model/doc/DocTag;
184+
}
185+
114186
public final class org/jetbrains/dokka/base/renderers/ContentTypeCheckingKt {
115187
public static final fun getURIExtension (Ljava/lang/String;)Ljava/lang/String;
116188
public static final fun isImage (Ljava/lang/String;)Z
@@ -1262,6 +1334,26 @@ public final class org/jetbrains/dokka/base/transformers/pages/tags/SinceKotlinT
12621334
public fun isApplicable (Lorg/jetbrains/dokka/model/doc/CustomTagWrapper;)Z
12631335
}
12641336

1337+
public final class org/jetbrains/dokka/base/translators/descriptors/DefaultDescriptorToDocumentableTranslator : org/jetbrains/dokka/base/translators/descriptors/ExternalClasslikesTranslator, org/jetbrains/dokka/transformers/sources/AsyncSourceToDocumentableTranslator {
1338+
public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V
1339+
public fun invoke (Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;Lorg/jetbrains/dokka/plugability/DokkaContext;)Lorg/jetbrains/dokka/model/DModule;
1340+
public fun invokeSuspending (Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;Lorg/jetbrains/dokka/plugability/DokkaContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
1341+
public fun translateClassDescriptor (Ljava/lang/Object;Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;)Lorg/jetbrains/dokka/model/DClasslike;
1342+
}
1343+
1344+
public final class org/jetbrains/dokka/base/translators/descriptors/DefaultExternalDocumentablesProvider : org/jetbrains/dokka/base/translators/descriptors/ExternalDocumentablesProvider {
1345+
public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V
1346+
public fun findClasslike (Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;)Lorg/jetbrains/dokka/model/DClasslike;
1347+
}
1348+
1349+
public abstract interface class org/jetbrains/dokka/base/translators/descriptors/ExternalClasslikesTranslator {
1350+
public abstract fun translateClassDescriptor (Ljava/lang/Object;Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;)Lorg/jetbrains/dokka/model/DClasslike;
1351+
}
1352+
1353+
public abstract interface class org/jetbrains/dokka/base/translators/descriptors/ExternalDocumentablesProvider {
1354+
public abstract fun findClasslike (Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;)Lorg/jetbrains/dokka/model/DClasslike;
1355+
}
1356+
12651357
public final class org/jetbrains/dokka/base/translators/documentables/BriefFromContentNodesKt {
12661358
public static final fun firstParagraphBrief (Lorg/jetbrains/dokka/model/doc/DocTag;)Lorg/jetbrains/dokka/model/doc/DocTag;
12671359
public static final fun firstSentenceBriefFromContentNodes (Ljava/util/List;)Ljava/util/List;
@@ -1459,3 +1551,9 @@ public class org/jetbrains/dokka/base/translators/documentables/PageContentBuild
14591551
public static synthetic fun row$default (Lorg/jetbrains/dokka/base/translators/documentables/PageContentBuilder$TableBuilder;Ljava/util/Set;Ljava/util/Set;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)V
14601552
}
14611553

1554+
public final class org/jetbrains/dokka/base/translators/psi/DefaultPsiToDocumentableTranslator : org/jetbrains/dokka/transformers/sources/AsyncSourceToDocumentableTranslator {
1555+
public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V
1556+
public fun invoke (Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;Lorg/jetbrains/dokka/plugability/DokkaContext;)Lorg/jetbrains/dokka/model/DModule;
1557+
public fun invokeSuspending (Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;Lorg/jetbrains/dokka/plugability/DokkaContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
1558+
}
1559+

‎plugins/base/src/main/kotlin/DokkaBase.kt

+44
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,50 @@ class DokkaBase : DokkaPlugin() {
242242
htmlPreprocessors providing ::SearchbarDataInstaller order { after(sourceLinksTransformer) }
243243
}
244244

245+
//<editor-fold desc="Deprecated API left for compatibility">
246+
@Suppress("DEPRECATION_ERROR")
247+
@Deprecated(message = org.jetbrains.dokka.base.deprecated.ANALYSIS_API_DEPRECATION_MESSAGE, level = DeprecationLevel.ERROR)
248+
val kotlinAnalysis by extensionPoint<org.jetbrains.dokka.analysis.KotlinAnalysis>()
249+
250+
@Suppress("DEPRECATION_ERROR")
251+
@Deprecated(message = org.jetbrains.dokka.base.deprecated.ANALYSIS_API_DEPRECATION_MESSAGE, level = DeprecationLevel.ERROR)
252+
val externalDocumentablesProvider by extensionPoint<org.jetbrains.dokka.base.translators.descriptors.ExternalDocumentablesProvider>()
253+
254+
@Suppress("DEPRECATION_ERROR")
255+
@Deprecated(message = org.jetbrains.dokka.base.deprecated.ANALYSIS_API_DEPRECATION_MESSAGE, level = DeprecationLevel.ERROR)
256+
val externalClasslikesTranslator by extensionPoint<org.jetbrains.dokka.base.translators.descriptors.ExternalClasslikesTranslator>()
257+
258+
@Suppress("DeprecatedCallableAddReplaceWith")
259+
@Deprecated(message = org.jetbrains.dokka.base.deprecated.ANALYSIS_API_DEPRECATION_MESSAGE, level = DeprecationLevel.ERROR)
260+
val descriptorToDocumentableTranslator: org.jetbrains.dokka.plugability.Extension<org.jetbrains.dokka.transformers.sources.SourceToDocumentableTranslator, *, *>
261+
get() = throw org.jetbrains.dokka.base.deprecated.AnalysisApiDeprecatedError()
262+
263+
@Suppress("DeprecatedCallableAddReplaceWith")
264+
@Deprecated(message = org.jetbrains.dokka.base.deprecated.ANALYSIS_API_DEPRECATION_MESSAGE, level = DeprecationLevel.ERROR)
265+
val psiToDocumentableTranslator: org.jetbrains.dokka.plugability.Extension<org.jetbrains.dokka.transformers.sources.SourceToDocumentableTranslator, *, *>
266+
get() = throw org.jetbrains.dokka.base.deprecated.AnalysisApiDeprecatedError()
267+
268+
@Suppress("DEPRECATION_ERROR", "DeprecatedCallableAddReplaceWith")
269+
@Deprecated(message = org.jetbrains.dokka.base.deprecated.ANALYSIS_API_DEPRECATION_MESSAGE, level = DeprecationLevel.ERROR)
270+
val defaultKotlinAnalysis: org.jetbrains.dokka.plugability.Extension<org.jetbrains.dokka.analysis.KotlinAnalysis, *, *>
271+
get() = throw org.jetbrains.dokka.base.deprecated.AnalysisApiDeprecatedError()
272+
273+
@Suppress("DeprecatedCallableAddReplaceWith")
274+
@Deprecated(message = org.jetbrains.dokka.base.deprecated.ANALYSIS_API_DEPRECATION_MESSAGE, level = DeprecationLevel.ERROR)
275+
val defaultSamplesTransformer: org.jetbrains.dokka.plugability.Extension<PageTransformer, *, *>
276+
get() = throw org.jetbrains.dokka.base.deprecated.AnalysisApiDeprecatedError()
277+
278+
@Suppress("DEPRECATION_ERROR", "DeprecatedCallableAddReplaceWith")
279+
@Deprecated(message = org.jetbrains.dokka.base.deprecated.ANALYSIS_API_DEPRECATION_MESSAGE, level = DeprecationLevel.ERROR)
280+
val defaultExternalDocumentablesProvider: org.jetbrains.dokka.plugability.Extension<org.jetbrains.dokka.base.translators.descriptors.ExternalDocumentablesProvider, *, *>
281+
get() = throw org.jetbrains.dokka.base.deprecated.AnalysisApiDeprecatedError()
282+
283+
@Suppress("DEPRECATION_ERROR", "DeprecatedCallableAddReplaceWith")
284+
@Deprecated(message = org.jetbrains.dokka.base.deprecated.ANALYSIS_API_DEPRECATION_MESSAGE, level = DeprecationLevel.ERROR)
285+
val defaultExternalClasslikesTranslator: org.jetbrains.dokka.plugability.Extension<org.jetbrains.dokka.base.translators.descriptors.ExternalClasslikesTranslator, *, *>
286+
get() = throw org.jetbrains.dokka.base.deprecated.AnalysisApiDeprecatedError()
287+
//</editor-fold>
288+
245289
@OptIn(DokkaPluginApiPreview::class)
246290
override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
247291
PluginApiPreviewAcknowledgement

‎plugins/base/src/main/kotlin/deprecated/AnalysisApiDeprecatedError.kt

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package org.jetbrains.dokka.base.deprecated
2+
3+
import org.jetbrains.dokka.InternalDokkaApi
4+
5+
// TODO all API that mentions this message or error can be removed in Dokka >= 2.1
6+
7+
internal const val ANALYSIS_API_DEPRECATION_MESSAGE =
8+
"Dokka's Analysis API has been reworked. Please, see the following issue for details and migration options: " +
9+
"https://github.com/Kotlin/dokka/issues/3099"
10+
11+
@InternalDokkaApi
12+
class AnalysisApiDeprecatedError : Error(ANALYSIS_API_DEPRECATION_MESSAGE)

0 commit comments

Comments
 (0)