base/org.jetbrains.dokka.base.transformers.documentables/DeprecatedDocumentableFilterTransformer

DeprecatedDocumentableFilterTransformer

class DeprecatedDocumentableFilterTransformer(val context: DokkaContext) : SuppressedByConditionDocumentableFilterTransformer
Content copied to clipboard

If PackageOptions.skipDeprecated or DokkaConfiguration.DokkaSourceSet.skipDeprecated is set to true, suppresses documentables marked with kotlin.Deprecated or java.lang.Deprecated. Package options are given preference over global options.

Documentables with kotlin.Deprecated.level set to DeprecationLevel.HIDDEN are suppressed regardless of global and package options.

Constructors

Link copied to clipboard
fun DeprecatedDocumentableFilterTransformer(context: DokkaContext)
Content copied to clipboard

Functions

Link copied to clipboard
open operator override fun invoke(modules: List<DModule>): List<DModule>
Content copied to clipboard
Link copied to clipboard
open override fun shouldBeSuppressed(d: Documentable): Boolean
Content copied to clipboard

Properties

Link copied to clipboard
val context: DokkaContext
Content copied to clipboard