aboutsummaryrefslogtreecommitdiff
path: root/plugins/android-documentation/src
diff options
context:
space:
mode:
authorMarcin Aman <marcin.aman@gmail.com>2021-03-01 13:50:17 +0100
committerGitHub <noreply@github.com>2021-03-01 13:50:17 +0100
commit7cf644f064868934fe8dcb46ab150f25fab8e8c8 (patch)
tree30d97e4cdaa6017401e7780bd86471f93d6f4d08 /plugins/android-documentation/src
parentab853a866c40771e84a3235f40575efe04c435c5 (diff)
downloaddokka-7cf644f064868934fe8dcb46ab150f25fab8e8c8.tar.gz
dokka-7cf644f064868934fe8dcb46ab150f25fab8e8c8.tar.bz2
dokka-7cf644f064868934fe8dcb46ab150f25fab8e8c8.zip
Add ability to suppress obvious functions like equals, toString... (#1758)
* Add ability to suppress obvious functions like equals, toString... * Add ability to suppress obvious functions like equals, toString...
Diffstat (limited to 'plugins/android-documentation/src')
-rw-r--r--plugins/android-documentation/src/main/kotlin/transformers/HideTagDocumentableFilter.kt4
-rw-r--r--plugins/android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt4
2 files changed, 4 insertions, 4 deletions
diff --git a/plugins/android-documentation/src/main/kotlin/transformers/HideTagDocumentableFilter.kt b/plugins/android-documentation/src/main/kotlin/transformers/HideTagDocumentableFilter.kt
index 074413cc..a8db6668 100644
--- a/plugins/android-documentation/src/main/kotlin/transformers/HideTagDocumentableFilter.kt
+++ b/plugins/android-documentation/src/main/kotlin/transformers/HideTagDocumentableFilter.kt
@@ -1,13 +1,13 @@
package org.jetbrains.dokka.android.transformers
-import org.jetbrains.dokka.base.transformers.documentables.SuppressedByTagDocumentableFilterTransformer
+import org.jetbrains.dokka.base.transformers.documentables.SuppressedByConditionDocumentableFilterTransformer
import org.jetbrains.dokka.model.Documentable
import org.jetbrains.dokka.model.dfs
import org.jetbrains.dokka.model.doc.CustomTagWrapper
import org.jetbrains.dokka.plugability.DokkaContext
class HideTagDocumentableFilter(val dokkaContext: DokkaContext) :
- SuppressedByTagDocumentableFilterTransformer(dokkaContext) {
+ SuppressedByConditionDocumentableFilterTransformer(dokkaContext) {
override fun shouldBeSuppressed(d: Documentable): Boolean =
d.documentation.any { (_, docs) -> docs.dfs { it is CustomTagWrapper && it.name.trim() == "hide" } != null }
} \ No newline at end of file
diff --git a/plugins/android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt b/plugins/android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt
index 01a802bf..82375201 100644
--- a/plugins/android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt
+++ b/plugins/android-documentation/src/test/kotlin/transformers/HideTagDocumentableFilterTest.kt
@@ -30,7 +30,7 @@ class HideTagDocumentableFilterTest : BaseAbstractTest() {
|}
""".trimIndent(), configuration
) {
- documentablesFirstTransformationStep = { modules ->
+ preMergeDocumentablesTransformationStage = { modules ->
val testingClass = modules.flatMap { it.packages }.flatMap { it.classlikes }.single() as DClass
assertEquals(0, testingClass.functions.size)
}
@@ -60,7 +60,7 @@ class HideTagDocumentableFilterTest : BaseAbstractTest() {
|}
""".trimIndent(), configuration
) {
- documentablesFirstTransformationStep = { modules ->
+ preMergeDocumentablesTransformationStage = { modules ->
val classes = modules.flatMap { it.packages }.flatMap { it.classlikes }.map { it.name }
assertEquals(listOf("Visible"), classes)
}