core/org.jetbrains.dokka.model/DParameter

DParameter

data class DParameter(val dri: DRI, val name: String?, val documentation: SourceSetDependent<DocumentationNode>, val expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, val type: Bound, val sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, val extra: PropertyContainer<DParameter> = PropertyContainer.empty()) : Documentable, WithExtraProperties<DParameter> , WithType

Constructors

constructor(dri: DRI, name: String?, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, type: Bound, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, extra: PropertyContainer<DParameter> = PropertyContainer.empty())

Properties

open override val children: List<Nothing>

open override val documentation: SourceSetDependent<DocumentationNode>

open override val dri: DRI

expectPresentInSet

open override val expectPresentInSet: DokkaConfiguration.DokkaSourceSet?

open override val extra: PropertyContainer<DParameter>

open override val name: String?

open override val sourceSets: Set<DokkaConfiguration.DokkaSourceSet>

open override val type: Bound

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<DParameter>): DParameter