core/org.jetbrains.dokka.pages/RootPageNode

RootPageNode

abstract class RootPageNode(val forceTopLevelName: Boolean = false) : PageNode

Inheritors

MultimoduleRootPageNode

RendererSpecificRootPage

Constructors

constructor(forceTopLevelName: Boolean = false)

Properties

abstract override val children: List<PageNode>

forceTopLevelName

val forceTopLevelName: Boolean = false

abstract 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

abstract override fun modified(name: String, children: List<PageNode>): RootPageNode

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>