Package org.jetbrains.dokka.base.renderers.html

Types

AssetsInstaller

object AssetsInstaller : PageTransformer

CustomResourceInstaller

class CustomResourceInstaller(dokkaContext: DokkaContext) : PageTransformer

HtmlRenderer

open class HtmlRenderer(context: DokkaContext) : DefaultRenderer<FlowContent>

NavigationDataProvider

abstract class NavigationDataProvider

NavigationNode

data class NavigationNode(name: String, dri: DRI, sourceSets: Set<DisplaySourceSet>, children: List<NavigationNode>) : WithChildren<NavigationNode>

NavigationPage

class NavigationPage(root: NavigationNode, moduleName: String, context: DokkaContext) : RendererSpecificPage

NavigationPageInstaller

open class NavigationPageInstaller(context: DokkaContext) : NavigationDataProvider, PageTransformer

NavigationSearchInstaller

open class NavigationSearchInstaller(context: DokkaContext) : NavigationDataProvider, PageTransformer

PageId

typealias PageId = String

ScriptsInstaller

class ScriptsInstaller(dokkaContext: DokkaContext) : PageTransformer

SearchbarDataInstaller

open class SearchbarDataInstaller(context: DokkaContext) : PageTransformer

SearchRecord

data class SearchRecord(name: String, description: String?, location: String, searchKeys: List<String>)

SourcesetDependencyAppender

class SourcesetDependencyAppender(context: DokkaContext) : PageTransformer

STRIKE

open class STRIKE(initialAttributes: Map<String, String>, consumer: TagConsumer<*>) : HTMLTag, HtmlBlockInlineTag

StylesInstaller

class StylesInstaller(dokkaContext: DokkaContext) : PageTransformer

TemplateBlock

typealias TemplateBlock = TemplateCommand.() -> Unit

TemplateCommand

class TemplateCommand(initialAttributes: Map<String, String>, consumer: TagConsumer<*>) : HTMLTag, CommonAttributeGroupFacadeFlowInteractivePhrasingContent

WBR

open class WBR(initialAttributes: Map<String, String>, consumer: TagConsumer<*>) : HTMLTag, HtmlBlockInlineTag

Functions

buildAsInnerHtml

fun TemplateBlock.buildAsInnerHtml(): String

buildBreakableDotSeparatedHtml

fun FlowContent.buildBreakableDotSeparatedHtml(name: String)

buildBreakableText

fun FlowContent.buildBreakableText(name: String)

buildTextBreakableAfterCapitalLetters

fun FlowContent.buildTextBreakableAfterCapitalLetters(name: String, hasLastElement: Boolean = false)

joinAttr

fun List<SimpleAttr>.joinAttr(): String

strike

inline fun FlowOrPhrasingContent.strike(classes: String? = null, crossinline block: STRIKE.() -> Unit = {})

Work-around until next version of kotlinx.

templateCommand

fun FlowOrMetaDataContent.templateCommand(data: Command, block: TemplateBlock = {})

fun <T> TagConsumer<T>.templateCommand(data: Command, block: TemplateBlock = {}): T

templateCommandFor

fun templateCommandFor(data: Command, consumer: TagConsumer<*>): TemplateCommand

transform

fun NavigationNode.transform(block: (NavigationNode) -> NavigationNode): NavigationNode

fun NavigationPage.transform(block: (NavigationNode) -> NavigationNode): NavigationPage

wbr

fun FlowOrPhrasingContent.wbr(classes: String? = null, block: WBR.() -> Unit = {})