core/org.jetbrains.dokka.model/DModule

DModule

data class DModule(val name: String, val packages: List<DPackage>, val documentation: SourceSetDependent<DocumentationNode>, val expectPresentInSet: DokkaConfiguration.DokkaSourceSet? = null, val sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, val extra: PropertyContainer<DModule> = PropertyContainer.empty()) : Documentable, WithExtraProperties<DModule>

Constructors

constructor(name: String, packages: List<DPackage>, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet? = null, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, extra: PropertyContainer<DModule> = 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? = null

open override val extra: PropertyContainer<DModule>

open override val name: String

val packages: List<DPackage>

open override val sourceSets: Set<DokkaConfiguration.DokkaSourceSet>

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