core/org.jetbrains.dokka.model/DObject

DObject

data class DObject(val name: String?, val dri: DRI, val documentation: SourceSetDependent<DocumentationNode>, val expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, val sources: SourceSetDependent<DocumentableSource>, val functions: List<DFunction>, val properties: List<DProperty>, val classlikes: List<DClasslike>, val visibility: SourceSetDependent<Visibility>, val supertypes: SourceSetDependent<List<TypeConstructorWithKind>>, val sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, val isExpectActual: Boolean, val extra: PropertyContainer<DObject> = PropertyContainer.empty()) : DClasslike, WithSupertypes, WithExtraProperties<DObject>

Constructors

constructor(name: String?, dri: DRI, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet?, sources: SourceSetDependent<DocumentableSource>, functions: List<DFunction>, properties: List<DProperty>, classlikes: List<DClasslike>, visibility: SourceSetDependent<Visibility>, supertypes: SourceSetDependent<List<TypeConstructorWithKind>>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, isExpectActual: Boolean, extra: PropertyContainer<DObject> = PropertyContainer.empty())

Properties

open override val children: List<Documentable>

open override val classlikes: List<DClasslike>

open override val documentation: SourceSetDependent<DocumentationNode>

open override val dri: DRI

expectPresentInSet

open override val expectPresentInSet: DokkaConfiguration.DokkaSourceSet?

open override val extra: PropertyContainer<DObject>

open override val functions: List<DFunction>

open override val isExpectActual: Boolean

open override val name: String?

open override val properties: List<DProperty>

open override val sources: SourceSetDependent<DocumentableSource>

open override val sourceSets: Set<DokkaConfiguration.DokkaSourceSet>

open override val supertypes: SourceSetDependent<List<TypeConstructorWithKind>>

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