core/org.jetbrains.dokka.pages/ModulePageNode

ModulePageNode

class ModulePageNode(val name: String, val content: ContentNode, val documentables: List<Documentable> = listOf(), val children: List<PageNode>, val embeddedResources: List<String> = listOf()) : RootPageNode, ModulePage

Constructors

constructor(name: String, content: ContentNode, documentables: List<Documentable> = listOf(), children: List<PageNode>, embeddedResources: List<String> = listOf())

Properties

open override val children: List<PageNode>

open override val content: ContentNode

open val ~~documentable~~: Documentable?

open override val documentables: List<Documentable>

open override val dri: Set<DRI>

embeddedResources

open override val embeddedResources: List<String>

forceTopLevelName

val forceTopLevelName: Boolean = false

open override val name: String

val parentMap: Map<PageNode, PageNode>

Functions

fun PageNode.alterChildren(block: PageNode.() -> PageNode): PageNode

inline fun <T : PageNode> PageNode.children(): List<T>

inline fun <T> WithChildren<*>.childrenOfType(): List<T>

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 PageNode.invokeOnAll(block: PageNode.() -> Unit): PageNode

open override fun modified(name: String, children: List<PageNode>): ModulePageNode

open override fun modified(name: String, content: ContentNode, dri: Set<DRI>, embeddedResources: List<String>, children: List<PageNode>): ModulePageNode

transformContentPagesTree

fun transformContentPagesTree(operation: (ContentPage) -> ContentPage): RootPageNode

transformPageNodeTree

fun transformPageNodeTree(operation: (PageNode) -> PageNode): RootPageNode

withDescendants

@JvmName(name = "withDescendantsProjection")

fun WithChildren<*>.withDescendants(): Sequence<Any?>

@JvmName(name = "withDescendantsAny")

fun WithChildren<Any>.withDescendants(): Sequence<Any>