quarkdown-quarkdoc/com.quarkdown.quarkdoc.dokka.kdoc/DocTagBuilder

DocTagBuilder

class DocTagBuilder

A DSL for building DocTags, which are used to represent documentation content in Dokka. This DSL allows for a more readable and structured way to create documentation tags.

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
fun build(): List<DocTag>
Link copied to clipboard
fun codeInline(text: String)
Link copied to clipboard
fun h1(block: DocTagBuilder.() -> Unit)
Link copied to clipboard
fun h2(block: DocTagBuilder.() -> Unit)
Link copied to clipboard
fun h3(block: DocTagBuilder.() -> Unit)
Link copied to clipboard
fun h4(block: DocTagBuilder.() -> Unit)
Link copied to clipboard
fun link(address: String, block: DocTagBuilder.() -> Unit)
fun link(address: String, text: String)
fun link(dri: DRI, block: DocTagBuilder.() -> Unit)
Link copied to clipboard
fun listItem(block: DocTagBuilder.() -> Unit)
Link copied to clipboard
fun DocTagBuilder.scrapingAnchor(anchor: String)

Creates an anchor element at documentation level for scraping purposes, which marks a specific section of documentation.

Link copied to clipboard
fun text(text: String)
Link copied to clipboard
fun unorderedList(block: DocTagBuilder.() -> Unit)