Package org.jetbrains.dokka.pages

Types

ClasslikePage

interface ClasslikePage : ContentPage, WithDocumentables

ClasslikePageNode

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

CommentTable

object CommentTable : Style

ContentBreakLine

data class ContentBreakLine(sourceSets: Set<DisplaySourceSet>, dci: DCI, style: Set<Style>, extra: PropertyContainer<ContentNode>) : ContentNode

ContentCode

interface ContentCode : ContentComposite

ContentCodeBlock

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

Code blocks

ContentCodeInline

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

ContentComposite

interface ContentComposite : ContentNode

Logical grouping of ContentNodes

ContentDivergentGroup

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

ContentDivergentInstance

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

Instance of a divergent content

ContentDRILink

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

All links to classes, packages, etc.

ContentEmbeddedResource

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

Embedded resources like images

ContentGroup

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

Default group, eg.

ContentHeader

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

Headers

ContentKind

enum ContentKind : Enum<ContentKind> , Kind

ContentKind represents a grouping of content of one kind.

ContentLink

interface ContentLink : ContentComposite

Union type replacement

ContentList

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

Lists

ContentNode

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

ContentPage

interface ContentPage : PageNode

ContentResolvedLink

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

All links that do not need to be resolved

ContentStyle

enum ContentStyle : Enum<ContentStyle> , Style

ContentTable

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

Tables

ContentText

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

Simple text

DCI

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

DriResolver

fun 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(name: String, content: ContentNode, dri: Set<DRI>, documentables: List<Documentable>, children: List<PageNode>, embeddedResources: List<String>) : MemberPage

ModulePage

interface ModulePage : ContentPage, WithDocumentables

ModulePageNode

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

MultimoduleRootPage

interface MultimoduleRootPage : ContentPage

MultimoduleRootPageNode

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

MultimoduleTable

object MultimoduleTable : Style

PackagePage

interface PackagePage : ContentPage, WithDocumentables

PackagePageNode

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

PageNode

interface PageNode : WithChildren<PageNode>

PageResolver

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

PlatformHintedContent

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

RendererSpecificPage

interface RendererSpecificPage : PageNode

RendererSpecificResourcePage

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

RendererSpecificRootPage

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

RenderingStrategy

sealed class RenderingStrategy

RootPageNode

abstract class RootPageNode(forceTopLevelName: Boolean) : PageNode

SimpleAttr

class SimpleAttr(extraKey: String, 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(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