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

Types

Link copied to clipboard
object AssetsInstaller : PageTransformer
Link copied to clipboard
class CustomResourceInstaller(val dokkaContext: DokkaContext) : PageTransformer
Link copied to clipboard
open class HtmlRenderer(context: DokkaContext) : DefaultRenderer<FlowContent>
Link copied to clipboard
abstract class NavigationDataProvider
Link copied to clipboard
data class NavigationNode(    val name: String,     val dri: DRI,     val sourceSets: Set<DisplaySourceSet>,     val children: List<NavigationNode>) : WithChildren<NavigationNode>
Link copied to clipboard
class NavigationPage(    val root: NavigationNode,     val moduleName: String,     val context: DokkaContext) : RendererSpecificPage
Link copied to clipboard
open class NavigationPageInstaller(val context: DokkaContext) : NavigationDataProvider, PageTransformer
Link copied to clipboard
class ScriptsInstaller(dokkaContext: DokkaContext) : PageTransformer
Link copied to clipboard
open class SearchbarDataInstaller(val context: DokkaContext) : PageTransformer
Link copied to clipboard
data class SearchRecord(    val name: String,     val description: String? = null,     val location: String,     val searchKeys: List<String> = listOf(name))
Link copied to clipboard
class SourcesetDependencyAppender(val context: DokkaContext) : PageTransformer
Link copied to clipboard
open class STRIKE(initialAttributes: Map<String, String>, val consumer: TagConsumer<*>) : HTMLTag, HtmlBlockInlineTag
Link copied to clipboard
class StylesInstaller(dokkaContext: DokkaContext) : PageTransformer
Link copied to clipboard
typealias TemplateBlock = TemplateCommand.() -> Unit
Link copied to clipboard
class TemplateCommand(initialAttributes: Map<String, String>, consumer: TagConsumer<*>) : HTMLTag, CommonAttributeGroupFacadeFlowInteractivePhrasingContent
Link copied to clipboard
open class WBR(initialAttributes: Map<String, String>, consumer: TagConsumer<*>) : HTMLTag, HtmlBlockInlineTag

Functions

Link copied to clipboard
fun TemplateBlock.buildAsInnerHtml(): String
Link copied to clipboard
fun FlowContent.buildBreakableDotSeparatedHtml(name: String)
Link copied to clipboard
fun FlowContent.buildBreakableText(name: String)
Link copied to clipboard
fun FlowContent.buildTextBreakableAfterCapitalLetters(name: String, hasLastElement: Boolean = false)
Link copied to clipboard
fun List<SimpleAttr>.joinAttr(): String
Link copied to clipboard
inline fun FlowOrPhrasingContent.strike(classes: String? = null, crossinline block: STRIKE.() -> Unit = {})

Work-around until next version of kotlinx.html doesn't come out

Link copied to clipboard
fun FlowOrMetaDataContent.templateCommand(data: Command, block: TemplateBlock = {})
fun <T> TagConsumer<T>.templateCommand(data: Command, block: TemplateBlock = {}): T
Link copied to clipboard
fun <T : Appendable> T.templateCommandAsHtmlComment(command: Command, action: T.() -> Unit)
fun FlowOrMetaDataContent.templateCommandAsHtmlComment(data: Command, block: FlowOrMetaDataContent.() -> Unit = {})
Link copied to clipboard
fun templateCommandFor(data: Command, consumer: TagConsumer<*>): TemplateCommand
Link copied to clipboard
fun NavigationNode.transform(block: (NavigationNode) -> NavigationNode): NavigationNode
fun NavigationPage.transform(block: (NavigationNode) -> NavigationNode): NavigationPage
Link copied to clipboard
fun FlowOrPhrasingContent.wbr(classes: String? = null, block: WBR.() -> Unit = {})

Properties

Link copied to clipboard
const val TEMPLATE_COMMAND_BEGIN_BORDER: String
Link copied to clipboard
const val TEMPLATE_COMMAND_END_BORDER: String
Link copied to clipboard
const val TEMPLATE_COMMAND_SEPARATOR: String