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

HtmlRenderer

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

Constructors

fun HtmlRenderer(context: DokkaContext)

Functions

open fun ContentNode.build( builder: FlowContent, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>? = null)

buildAnchorCopyButton

fun FlowContent.buildAnchorCopyButton(pointingTo: String)

buildCodeBlock

open override fun FlowContent.buildCodeBlock(code: ContentCodeBlock, pageContext: ContentPage)

buildCodeInline

open override fun FlowContent.buildCodeInline(code: ContentCodeInline, pageContext: ContentPage)

buildContentNode

open fun FlowContent.buildContentNode( node: ContentNode, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>? = null)

buildDefaultTable

fun FlowContent.buildDefaultTable( node: ContentTable, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>?)

buildDivergent

open override fun FlowContent.buildDivergent(node: ContentDivergentGroup, pageContext: ContentPage)

buildDivergentInstance

open fun FlowContent.buildDivergentInstance(node: ContentDivergentInstance, pageContext: ContentPage)

buildDRILink

open override fun FlowContent.buildDRILink( node: ContentDRILink, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>?)

buildError

open override fun buildError(node: ContentNode)

buildGroup

open fun FlowContent.buildGroup( node: ContentGroup, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>? = null)

buildHeader

open override fun FlowContent.buildHeader( level: Int, node: ContentHeader, content: FlowContent.() -> Unit)

open fun FlowContent.buildHeader( node: ContentHeader, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>? = null)

buildHtml

open fun buildHtml( page: PageNode, resources: List<String>, content: FlowContent.() -> Unit): String

buildLineBreak

open override fun FlowContent.buildLineBreak()

buildLink

open override fun FlowContent.buildLink(address: String, content: FlowContent.() -> Unit)

fun FlowContent.buildLink( to: DRI, platforms: List<DisplaySourceSet>, from: PageNode? = null, block: FlowContent.() -> Unit)

buildList

open override fun FlowContent.buildList( node: ContentList, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>?)

buildListItems

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)

buildNavigation

open override fun FlowContent.buildNavigation(page: PageNode)

buildPage

open override fun buildPage(page: ContentPage, content: (FlowContent, ContentPage) -> Unit): String

buildPageContent

open fun buildPageContent(context: FlowContent, page: ContentPage)

buildPlatformDependent

open override fun FlowContent.buildPlatformDependent( content: PlatformHintedContent, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>?)

buildResolvedLink

open fun FlowContent.buildResolvedLink( node: ContentResolvedLink, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>?)

buildResource

open override fun FlowContent.buildResource(node: ContentEmbeddedResource, pageContext: ContentPage)

buildTable

open override fun FlowContent.buildTable( node: ContentTable, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>?)

buildText

open override fun FlowContent.buildText(textNode: ContentText)

open fun FlowContent.buildText( nodes: List<ContentNode>, pageContext: ContentPage, sourceSetRestriction: Set<DisplaySourceSet>? = null)

clickableLogo

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

render

open override fun render(root: RootPageNode)

renderPage

open suspend fun renderPage(page: PageNode)

wrapGroup

open override fun FlowContent.wrapGroup( node: ContentGroup, pageContext: ContentPage, childrenCallback: FlowContent.() -> Unit)