aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src/main/kotlin/deprecated/AnalysisApiDeprecatedError.kt
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/base/src/main/kotlin/deprecated/AnalysisApiDeprecatedError.kt')
-rw-r--r--plugins/base/src/main/kotlin/deprecated/AnalysisApiDeprecatedError.kt12
1 files changed, 12 insertions, 0 deletions
diff --git a/plugins/base/src/main/kotlin/deprecated/AnalysisApiDeprecatedError.kt b/plugins/base/src/main/kotlin/deprecated/AnalysisApiDeprecatedError.kt
new file mode 100644
index 00000000..bc711648
--- /dev/null
+++ b/plugins/base/src/main/kotlin/deprecated/AnalysisApiDeprecatedError.kt
@@ -0,0 +1,12 @@
+package org.jetbrains.dokka.base.deprecated
+
+import org.jetbrains.dokka.InternalDokkaApi
+
+// TODO all API that mentions this message or error can be removed in Dokka >= 2.1
+
+internal const val ANALYSIS_API_DEPRECATION_MESSAGE =
+ "Dokka's Analysis API has been reworked. Please, see the following issue for details and migration options: " +
+ "https://github.com/Kotlin/dokka/issues/3099"
+
+@InternalDokkaApi
+class AnalysisApiDeprecatedError : Error(ANALYSIS_API_DEPRECATION_MESSAGE)