core/org.jetbrains.dokka.model/DisplaySourceSet

DisplaySourceSet

data class DisplaySourceSet(val sourceSetIDs: CompositeSourceSetID, val name: String, val platform: Platform)

Represents a final user-visible source set in the documentable model that is used to specify under which source sets/targets current signatures are available, can be used to filter in and out all available signatures under the specified source set, and, depending on the format, are rendered as "platform" selectors.

E.g. HTML format renders display source sets as "bubbles" that later are used for filtering and informational purposes.

DisplaySourceSets typically have a one-to-one correspondence to the build system source sets, are created by the base plugin from DokkaSourceSet and never tweaked manually. DisplaySourceSet is uniquely identified by the corresponding CompositeSourceSetID.

Constructors

DisplaySourceSet

constructor(sourceSet: DokkaConfiguration.DokkaSourceSet)

constructor(sourceSetIDs: CompositeSourceSetID, name: String, platform: Platform)

Properties

name

val name: String

corresponds to the name of the original DokkaSourceSet

platform

val platform: Platform

the platform of the source set. If the source set is a mix of multiple source sets that correspond to multiple KMP platforms, then it is Platform.common

sourceSetIDs

val sourceSetIDs: CompositeSourceSetID

unique stable id of the display source set. It is composite by definition, as it uniquely defines the source set and all nested source sets. Apart from names, it also contains a substitute to a full source set path in order to differentiate source sets with the same name in a stable manner.