Package org.jetbrains.dokka.pages

Types

interface ClasslikePage : ContentPage, WithDocumentables

class ClasslikePageNode( val name: String, val content: ContentNode, val dri: Set<DRI>, val documentables: List<Documentable> = listOf(), val children: List<PageNode>, val embeddedResources: List<String> = listOf()) : ClasslikePage

CommentTable

object CommentTable : Style

ContentBreakLine

data class ContentBreakLine( val sourceSets: Set<DisplaySourceSet>, val dci: DCI = DCI(emptySet(), ContentKind.Empty), val style: Set<Style> = emptySet(), val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentNode

ContentCode

interface ContentCode : ContentComposite

ContentCodeBlock

data class ContentCodeBlock( val children: List<ContentNode>, val language: String, val dci: DCI, val sourceSets: Set<DisplaySourceSet>, val style: Set<Style>, val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentCode

Code blocks

ContentCodeInline

data class ContentCodeInline( val children: List<ContentNode>, val language: String, val dci: DCI, val sourceSets: Set<DisplaySourceSet>, val style: Set<Style>, val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentCode

ContentComposite

interface ContentComposite : ContentNode

Logical grouping of ContentNodes

ContentDivergentGroup

data class ContentDivergentGroup( val children: List<ContentDivergentInstance>, val dci: DCI, val style: Set<Style>, val extra: PropertyContainer<ContentNode>, val groupID: ContentDivergentGroup.GroupID, val implicitlySourceSetHinted: Boolean = true) : ContentComposite

ContentDivergentInstance

data class ContentDivergentInstance( val before: ContentNode?, val divergent: ContentNode, val after: ContentNode?, val dci: DCI, val sourceSets: Set<DisplaySourceSet>, val style: Set<Style>, val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentComposite

Instance of a divergent content

ContentDRILink

data class ContentDRILink( val children: List<ContentNode>, val address: DRI, val dci: DCI, val sourceSets: Set<DisplaySourceSet>, val style: Set<Style> = emptySet(), val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentLink

All links to classes, packages, etc. that have te be resolved

ContentEmbeddedResource

data class ContentEmbeddedResource( val children: List<ContentNode> = emptyList(), val address: String, val altText: String?, val dci: DCI, val sourceSets: Set<DisplaySourceSet>, val style: Set<Style> = emptySet(), val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentLink

Embedded resources like images

ContentGroup

data class ContentGroup( val children: List<ContentNode>, val dci: DCI, val sourceSets: Set<DisplaySourceSet>, val style: Set<Style>, val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentComposite

Default group, eg. for blocks of Functions, Properties, etc.

ContentHeader

data class ContentHeader( val children: List<ContentNode>, val level: Int, val dci: DCI, val sourceSets: Set<DisplaySourceSet>, val style: Set<Style>, val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentComposite

Headers

ContentKind

enum ContentKind : Enum<ContentKind> , Kind

ContentKind represents a grouping of content of one kind. This can be rendered as either a part of a composite page (one tab/block within a class's page, for instance) or as a separate page altogether.

ContentLink

interface ContentLink : ContentComposite

Union type replacement

ContentList

data class ContentList( val children: List<ContentNode>, val ordered: Boolean, val dci: DCI, val sourceSets: Set<DisplaySourceSet>, val style: Set<Style>, val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentComposite

Lists

ContentNode

interface ContentNode : WithExtraProperties<ContentNode> , WithChildren<ContentNode>

ContentPage

interface ContentPage : PageNode

ContentResolvedLink

data class ContentResolvedLink( val children: List<ContentNode>, val address: String, val dci: DCI, val sourceSets: Set<DisplaySourceSet>, val style: Set<Style> = emptySet(), val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentLink

All links that do not need to be resolved

ContentStyle

enum ContentStyle : Enum<ContentStyle> , Style

ContentTable

data class ContentTable( val header: List<ContentGroup>, val caption: ContentGroup? = null, val children: List<ContentGroup>, val dci: DCI, val sourceSets: Set<DisplaySourceSet>, val style: Set<Style>, val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentComposite

Tables

ContentText

data class ContentText( val text: String, val dci: DCI, val sourceSets: Set<DisplaySourceSet>, val style: Set<Style> = emptySet(), val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()) : ContentNode

Simple text

DCI

data class DCI(val dri: Set<DRI>, val kind: Kind)

DriResolver

fun interface DriResolver : Function2<DRI, Set<DisplaySourceSet>, String?>

HtmlContent

object HtmlContent : ExtraProperty<ContentNode> , ExtraProperty.Key<ContentNode, HtmlContent>

Kind

interface Kind

ListStyle

enum ListStyle : Enum<ListStyle> , Style

MemberPage

interface MemberPage : ContentPage, WithDocumentables

MemberPageNode

class MemberPageNode( val name: String, val content: ContentNode, val dri: Set<DRI>, val documentables: List<Documentable> = listOf(), val children: List<PageNode> = emptyList(), val embeddedResources: List<String> = listOf()) : MemberPage

ModulePage

interface ModulePage : ContentPage, WithDocumentables

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

MultimoduleRootPage

interface MultimoduleRootPage : ContentPage

MultimoduleRootPageNode

class MultimoduleRootPageNode( val dri: Set<DRI>, val content: ContentNode, val embeddedResources: List<String> = emptyList()) : RootPageNode, MultimoduleRootPage

MultimoduleTable

object MultimoduleTable : Style

PackagePage

interface PackagePage : ContentPage, WithDocumentables

PackagePageNode

class PackagePageNode( val name: String, val content: ContentNode, val dri: Set<DRI>, val documentables: List<Documentable> = listOf(), val children: List<PageNode>, val embeddedResources: List<String> = listOf()) : PackagePage

PageNode

interface PageNode : WithChildren<PageNode>

PageResolver

fun interface PageResolver : Function2<PageNode, PageNode?, String?>

PlatformHintedContent

data class PlatformHintedContent(val inner: ContentNode, val sourceSets: Set<DisplaySourceSet>) : ContentComposite

RendererSpecificPage

interface RendererSpecificPage : PageNode

RendererSpecificResourcePage

class RendererSpecificResourcePage( val name: String, val children: List<PageNode>, val strategy: RenderingStrategy) : RendererSpecificPage

RendererSpecificRootPage

class RendererSpecificRootPage( val name: String, val children: List<PageNode>, val strategy: RenderingStrategy) : RootPageNode, RendererSpecificPage

RenderingStrategy

sealed class RenderingStrategy

RootPageNode

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

SimpleAttr

class SimpleAttr(val extraKey: String, val extraValue: String) : ExtraProperty<ContentNode>

Style

interface Style

SymbolContentKind

enum SymbolContentKind : Enum<SymbolContentKind> , Kind

Content kind for ContentKind.Symbol content, which is essentially about signatures

TextStyle

enum TextStyle : Enum<TextStyle> , Style

TokenStyle

enum TokenStyle : Enum<TokenStyle> , Style

WithDocumentables

interface WithDocumentables

WrongRendererTypeException

data class WrongRendererTypeException(val expectedType: KClass<*>) : Exception

Functions

children

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

hasStyle

fun ContentNode.hasStyle(style: Style): Boolean

mapTransform

inline fun <T : ContentNode, R : ContentNode> R.mapTransform(noinline operation: (T) -> T): R

recursiveMapTransform

inline fun <T : ContentNode, R : ContentNode> R.recursiveMapTransform(noinline operation: (T) -> T): R