base/org.jetbrains.dokka.base.renderers.html

Package-level declarations

Types

AssetsInstaller

object AssetsInstaller : PageTransformer

CustomResourceInstaller

class CustomResourceInstaller(val dokkaContext: DokkaContext) : PageTransformer

HtmlRenderer

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

NavigationDataProvider

abstract class NavigationDataProvider

NavigationNode

data class NavigationNode(val name: String, val dri: DRI, val sourceSets: Set<DisplaySourceSet>, val icon: NavigationNodeIcon?, val styles: Set<Style> = emptySet(), val children: List<NavigationNode>) : WithChildren<NavigationNode>

NavigationNodeIcon

enum NavigationNodeIcon : Enum<NavigationNodeIcon>

CLASS represents a neutral (a.k.a Java-style) icon, whereas CLASS_KT should be Kotlin-styled

NavigationPage

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

NavigationPageInstaller

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

ScriptsInstaller

class ScriptsInstaller(dokkaContext: DokkaContext) : PageTransformer

SearchbarDataInstaller

open class SearchbarDataInstaller(val context: DokkaContext) : PageTransformer

SearchRecord

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

SourcesetDependencyAppender

class SourcesetDependencyAppender(val context: DokkaContext) : PageTransformer

STRIKE

open class STRIKE(initialAttributes: Map<String, String>, val 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

UNDERLINE

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

WBR

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

Properties

TEMPLATE_COMMAND_BEGIN_BORDER

const val TEMPLATE_COMMAND_BEGIN_BORDER: String

TEMPLATE_COMMAND_END_BORDER

const val TEMPLATE_COMMAND_END_BORDER: String

TEMPLATE_COMMAND_SEPARATOR

const val TEMPLATE_COMMAND_SEPARATOR: String

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.html doesn't come out

templateCommand

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

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

templateCommandAsHtmlComment

fun <T : Appendable> T.templateCommandAsHtmlComment(command: Command, action: T.() -> Unit)

fun FlowOrMetaDataContent.templateCommandAsHtmlComment(data: Command, block: FlowOrMetaDataContent.() -> Unit = {})

templateCommandFor

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

transform

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

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

underline

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

wbr

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