core/org.jetbrains.dokka.model/DPackage

DPackage

data class DPackage(val dri: DRI, val functions: List<DFunction>, val properties: List<DProperty>, val classlikes: List<DClasslike>, val typealiases: List<DTypeAlias>, val documentation: SourceSetDependent<DocumentationNode>, val expectPresentInSet: DokkaConfiguration.DokkaSourceSet? = null, val sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, val extra: PropertyContainer<DPackage> = PropertyContainer.empty()) : Documentable, WithScope, WithExtraProperties<DPackage>

Constructors

Link copied to clipboard
constructor(dri: DRI, functions: List<DFunction>, properties: List<DProperty>, classlikes: List<DClasslike>, typealiases: List<DTypeAlias>, documentation: SourceSetDependent<DocumentationNode>, expectPresentInSet: DokkaConfiguration.DokkaSourceSet? = null, sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, extra: PropertyContainer<DPackage> = PropertyContainer.empty())

Properties

Link copied to clipboard
open override val children: List<Documentable>
Link copied to clipboard
open override val classlikes: List<DClasslike>
Link copied to clipboard
Link copied to clipboard
open override val dri: DRI
Link copied to clipboard
Link copied to clipboard
open override val extra: PropertyContainer<DPackage>
Link copied to clipboard
open override val functions: List<DFunction>
Link copied to clipboard
open override val name: String

!!! WARNING !!! This name is not guaranteed to be a be a canonical/real package name. e.g. this will return a human readable version for root packages. Use packageName or dri.packageName instead to obtain the real packageName

Link copied to clipboard
Link copied to clipboard
open override val properties: List<DProperty>
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
inline fun <T> WithChildren<*>.childrenOfType(): List<T>
Link copied to clipboard
Link copied to clipboard
inline fun <T> WithChildren<*>.firstChildOfType(): T
inline fun <T> WithChildren<*>.firstChildOfType(predicate: (T) -> Boolean): T
Link copied to clipboard
inline fun <T> WithChildren<*>.firstChildOfTypeOrNull(): T?
inline fun <T> WithChildren<*>.firstChildOfTypeOrNull(predicate: (T) -> Boolean): T?
Link copied to clipboard
inline fun <T : WithChildren<*>> WithChildren<WithChildren<*>>.firstMemberOfType(): T
inline fun <T : WithChildren<*>> WithChildren<WithChildren<*>>.firstMemberOfType(predicate: (T) -> Boolean): T
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@JvmName(name = "withDescendantsProjection")
fun WithChildren<*>.withDescendants(): Sequence<Any?>
@JvmName(name = "withDescendantsAny")
fun WithChildren<Any>.withDescendants(): Sequence<Any>
Link copied to clipboard
open override fun withNewExtras(newExtras: PropertyContainer<DPackage>): DPackage