Add Dokka filter to suppress java collection functions

vmishenev · Mar 31, 2023 · 8997a9a · 8997a9a
1 parent 4fabe8b
commit 8997a9a
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 0 deletions.
diff --git a/...in/org/jetbrains/dokka/kotlinlang/JavaCollectionFunctionsDocumentableFilterTransformer.kt b/...in/org/jetbrains/dokka/kotlinlang/JavaCollectionFunctionsDocumentableFilterTransformer.kt
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2010-2023 JetBrains s.r.o. and Kotlin Programming Language contributors.
+ * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
+ */
+
+package org.jetbrains.dokka.kotlinlang
+
+import org.jetbrains.dokka.base.transformers.documentables.SuppressedByConditionDocumentableFilterTransformer
+import org.jetbrains.dokka.model.DFunction
+import org.jetbrains.dokka.model.Documentable
+import org.jetbrains.dokka.plugability.DokkaContext
+
+/**
+ * Suppress some methods inherited from [java.util.Collection]:
+ * - The old StdLib doesn't contain them
+ * - Source code of [kotlin.collections.Collection] and other classes of (Java mapping)[https://kotlinlang.org/docs/java-interop.html#mapped-types]
+ * don't have them, although these methods can be called
+ */
+class JavaCollectionFunctionsDocumentableFilterTransformer(context: DokkaContext) :
+    SuppressedByConditionDocumentableFilterTransformer(context) {
+    data class FullyQualifiedMethodName(
+        val packageName: String, val classNames: String, val methodName: String
+    )
+
+    private val methodNames = listOf(
+        FullyQualifiedMethodName("kotlin.collections", "Collection", "stream"),
+        FullyQualifiedMethodName("kotlin.collections", "Collection", "parallelStream"),
+        FullyQualifiedMethodName("kotlin.collections", "Collection", "spliterator"),
+        FullyQualifiedMethodName("kotlin.collections", "Collection", "toArray"),
+        FullyQualifiedMethodName("kotlin.collections", "Iterable", "forEach"),
+        FullyQualifiedMethodName("kotlin.collections", "MutableCollection", "removeIf")
+    )
+
+    override fun shouldBeSuppressed(d: Documentable): Boolean = d is DFunction && methodNames.firstOrNull {
+        it.packageName == d.dri.packageName && it.classNames == d.dri.classNames && it.methodName == d.dri.callable?.name
+    } != null
+}
diff --git a/...ration-plugin/src/main/kotlin/org/jetbrains/dokka/kotlinlang/StdLibConfigurationPlugin.kt b/...ration-plugin/src/main/kotlin/org/jetbrains/dokka/kotlinlang/StdLibConfigurationPlugin.kt
@@ -9,6 +9,8 @@ import org.jetbrains.dokka.base.DokkaBase
 import org.jetbrains.dokka.plugability.DokkaPlugin
 import org.jetbrains.dokka.analysis.DokkaAnalysisConfiguration
 import org.jetbrains.dokka.analysis.ProjectKotlinAnalysis
+import org.jetbrains.dokka.plugability.DokkaPluginApiPreview
+import org.jetbrains.dokka.plugability.PluginApiPreviewAcknowledgement
 import org.jetbrains.dokka.plugability.configuration
 
 class StdLibConfigurationPlugin : DokkaPlugin() {
@@ -25,4 +27,12 @@ class StdLibConfigurationPlugin : DokkaPlugin() {
             )
         } override dokkaBase.defaultKotlinAnalysis
     }
+
+    @Suppress("unused")
+    val javaCollectionFunctionsFilter by extending {
+        dokkaBase.preMergeDocumentableTransformer providing ::JavaCollectionFunctionsDocumentableFilterTransformer
+    }
+
+    @DokkaPluginApiPreview
+    override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement = PluginApiPreviewAcknowledgement
 }