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

fun DPackage( 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())

Functions

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

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? = null

open override val extra: PropertyContainer<DPackage>

open override val functions: List<DFunction>

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

val packageName: String

open override val properties: List<DProperty>

open override val sourceSets: Set<DokkaConfiguration.DokkaSourceSet>

val typealiases: List<DTypeAlias>