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

Package org.jetbrains.dokka.base.transformers.documentables

Types

ActualTypealiasAdder

class ActualTypealiasAdder : DocumentableTransformer

CallableExtensions

data class CallableExtensions(val extensions: Set<Callable>) : ExtraProperty<Documentable>

ClashingDriIdentifier

data class ClashingDriIdentifier(val value: Set<DokkaConfiguration.DokkaSourceSet>) : ExtraProperty<Documentable>

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.

DocumentableReplacerTransformer

abstract class DocumentableReplacerTransformer(val context: DokkaContext) : PreMergeDocumentableTransformer

DocumentableVisibilityFilterTransformer

class DocumentableVisibilityFilterTransformer(val context: DokkaContext) : PreMergeDocumentableTransformer

EmptyModulesFilterTransformer

class EmptyModulesFilterTransformer : PreMergeDocumentableTransformer

EmptyPackagesFilterTransformer

class EmptyPackagesFilterTransformer(val context: DokkaContext) : PreMergeDocumentableTransformer

ExtensionExtractorTransformer

class ExtensionExtractorTransformer : DocumentableTransformer

InheritedEntriesDocumentableFilterTransformer

class InheritedEntriesDocumentableFilterTransformer(val context: DokkaContext) : SuppressedByConditionDocumentableFilterTransformer

InheritorsExtractorTransformer

class InheritorsExtractorTransformer : DocumentableTransformer

InheritorsInfo

class InheritorsInfo(val value: SourceSetDependent<List<DRI>>) : ExtraProperty<Documentable>

KotlinArrayDocumentableReplacerTransformer

class KotlinArrayDocumentableReplacerTransformer(val context: DokkaContext) : DocumentableReplacerTransformer

ObviousFunctionsDocumentableFilterTransformer

class ObviousFunctionsDocumentableFilterTransformer(val context: DokkaContext) : SuppressedByConditionDocumentableFilterTransformer

SuppressedByConditionDocumentableFilterTransformer

abstract class SuppressedByConditionDocumentableFilterTransformer(val context: DokkaContext) : PreMergeDocumentableTransformer

SuppressedByConfigurationDocumentableFilterTransformer

class SuppressedByConfigurationDocumentableFilterTransformer(val context: DokkaContext) : PreMergeDocumentableTransformer

SuppressTagDocumentableFilter

class SuppressTagDocumentableFilter(val dokkaContext: DokkaContext) : SuppressedByConditionDocumentableFilterTransformer

Functions

consumeAsFlow

fun <T : Any> ReceiveChannel<T>.consumeAsFlow(): Flow<T>

isDeprecated

fun <T : WithExtraProperties<out Documentable>> T.isDeprecated(): Boolean

Properties

deprecatedAnnotation

val <T : WithExtraProperties<out Documentable>> T.deprecatedAnnotation: Annotations.Annotation?

isException

val <T : WithExtraProperties<out Documentable>> T.isException: Boolean