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

HtmlRenderer

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

Constructors

Link copied to clipboard
constructor(context: DokkaContext)

Functions

Link copied to clipboard
open fun ContentNode.build(builder: FlowContent, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>? = null)
Link copied to clipboard
fun FlowContent.buildAnchorCopyButton(pointingTo: String)
Link copied to clipboard
open override fun FlowContent.buildCodeBlock(code: ContentCodeBlock, pageContext: ContentPage)
Link copied to clipboard
open override fun FlowContent.buildCodeInline(code: ContentCodeInline, pageContext: ContentPage)
Link copied to clipboard
open fun FlowContent.buildContentNode(node: ContentNode, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>? = null)
Link copied to clipboard
fun FlowContent.buildDefaultTable(node: ContentTable, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>?)
Link copied to clipboard
open override fun FlowContent.buildDivergent(node: ContentDivergentGroup, pageContext: ContentPage)
Link copied to clipboard
open fun FlowContent.buildDivergentInstance(node: ContentDivergentInstance, pageContext: ContentPage)
Link copied to clipboard
open override fun FlowContent.buildDRILink(node: ContentDRILink, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>?)
Link copied to clipboard
open override fun buildError(node: ContentNode)
Link copied to clipboard
open fun FlowContent.buildGroup(node: ContentGroup, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>? = null)
Link copied to clipboard
open fun FlowContent.buildHeader(node: ContentHeader, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>? = null)
open override fun FlowContent.buildHeader(level: Int, node: ContentHeader, content: FlowContent.() -> Unit)
Link copied to clipboard
open fun buildHtml(page: PageNode, resources: List<String>, content: FlowContent.() -> Unit): String
Link copied to clipboard
open override fun FlowContent.buildLineBreak()
open override fun FlowContent.buildLineBreak(node: ContentBreakLine, pageContext: ContentPage)
Link copied to clipboard
open override fun FlowContent.buildLink(address: String, content: FlowContent.() -> Unit)
fun FlowContent.buildLink(to: DRI, platforms: List<DisplaySourceSet>, from: PageNode? = null, block: FlowContent.() -> Unit)
Link copied to clipboard
open override fun FlowContent.buildList(node: ContentList, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>?)
Link copied to clipboard
open fun OL.buildListItems(items: List<ContentNode>, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>? = null)
open fun UL.buildListItems(items: List<ContentNode>, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>? = null)
Link copied to clipboard
open override fun FlowContent.buildNavigation(page: PageNode)
Link copied to clipboard
open override fun buildPage(page: ContentPage, content: (FlowContent, ContentPage) -> Unit): String
Link copied to clipboard
open fun buildPageContent(context: FlowContent, page: ContentPage)
Link copied to clipboard
open override fun FlowContent.buildPlatformDependent(content: PlatformHintedContent, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>?)
Link copied to clipboard
open fun FlowContent.buildResolvedLink(node: ContentResolvedLink, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>?)
Link copied to clipboard
open override fun FlowContent.buildResource(node: ContentEmbeddedResource, pageContext: ContentPage)
Link copied to clipboard
open override fun FlowContent.buildTable(node: ContentTable, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>?)
Link copied to clipboard
open fun FlowContent.buildText(nodes: List<ContentNode>, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>? = null)
open override fun FlowContent.buildText(textNode: ContentText)
Link copied to clipboard
open fun FlowContent.clickableLogo(page: PageNode, pathToRoot: String)

This is deliberately left open for plugins that have some other pages above ours and would like to link to them instead of ours when clicking the logo

Link copied to clipboard
open override fun render(root: RootPageNode)
Link copied to clipboard
open suspend fun renderPage(page: PageNode)
Link copied to clipboard
open override fun FlowContent.wrapGroup(node: ContentGroup, pageContext: ContentPage, childrenCallback: FlowContent.() -> Unit)