core/org.jetbrains.dokka.model/DFunction

DFunction

data class DFunction(val dri: DRI, val name: String, val isConstructor: Boolean, val parameters: List<DParameter>, val documentation: SourceSetDependent<DocumentationNode>, val expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, val sources: SourceSetDependent<DocumentableSource>, val visibility: SourceSetDependent<Visibility>, val type: Bound, val generics: List<DTypeParameter>, val receiver: DParameter?, val modifier: SourceSetDependent<Modifier>, val sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, val isExpectActual: Boolean, val extra: PropertyContainer<DFunction> = PropertyContainer.empty()) : Documentable, Callable, WithGenerics, WithExtraProperties<DFunction>

Constructors

constructor(dri: DRI, name: String, isConstructor: Boolean, parameters: List<DParameter>, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, sources: SourceSetDependent<DocumentableSource>, visibility: SourceSetDependent<Visibility>, type: Bound, generics: List<DTypeParameter>, receiver: DParameter?, modifier: SourceSetDependent<Modifier>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, isExpectActual: Boolean, extra: PropertyContainer<DFunction> = PropertyContainer.empty())

Properties

open override val children: List<Documentable>

open override val documentation: SourceSetDependent<DocumentationNode>

open override val dri: DRI

expectPresentInSet

open override val expectPresentInSet: DokkaConfiguration.DokkaSourceSet?

open override val extra: PropertyContainer<DFunction>

open override val generics: List<DTypeParameter>

val isConstructor: Boolean

open override val isExpectActual: Boolean

open override val modifier: SourceSetDependent<Modifier>

open override val name: String

val parameters: List<DParameter>

open override val receiver: DParameter?

open override val sources: SourceSetDependent<DocumentableSource>

open override val sourceSets: Set<DokkaConfiguration.DokkaSourceSet>

open override val type: Bound

open override val visibility: SourceSetDependent<Visibility>

Functions

inline fun <T> WithChildren<*>.childrenOfType(): List<T>

fun Documentable.dfs(predicate: (Documentable) -> Boolean): Documentable?

firstChildOfType

inline fun <T> WithChildren<*>.firstChildOfType(): T

inline fun <T> WithChildren<*>.firstChildOfType(predicate: (T) -> Boolean): T

firstChildOfTypeOrNull

inline fun <T> WithChildren<*>.firstChildOfTypeOrNull(): T?

inline fun <T> WithChildren<*>.firstChildOfTypeOrNull(predicate: (T) -> Boolean): T?

firstMemberOfType

inline fun <T : WithChildren<*>> WithChildren<WithChildren<*>>.firstMemberOfType(): T

inline fun <T : WithChildren<*>> WithChildren<WithChildren<*>>.firstMemberOfType(predicate: (T) -> Boolean): T

firstMemberOfTypeOrNull

inline fun <T : WithChildren<*>> WithChildren<WithChildren<*>>.firstMemberOfTypeOrNull(): T?

fun Documentable.isExtension(): Boolean

withDescendants

@JvmName(name = "withDescendantsProjection")

fun WithChildren<*>.withDescendants(): Sequence<Any?>

@JvmName(name = "withDescendantsAny")

fun WithChildren<Any>.withDescendants(): Sequence<Any>

open override fun withNewExtras(newExtras: PropertyContainer<DFunction>): DFunction