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

DeprecatedDocumentableFilterTransformer

class DeprecatedDocumentableFilterTransformer(val context: DokkaContext) : SuppressedByConditionDocumentableFilterTransformer

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
constructor(context: DokkaContext)

Properties

Link copied to clipboard
val context: DokkaContext

Functions

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