base/org.jetbrains.dokka.base.translators.documentables/PageContentBuilder/DocumentableContentBuilder

DocumentableContentBuilder

open inner class DocumentableContentBuilder(val mainDRI: Set<DRI>, val mainSourcesetData: Set<DokkaConfiguration.DokkaSourceSet>, val mainStyles: Set<Style>, val mainExtra: PropertyContainer<ContentNode>)

Constructors

constructor(mainDRI: Set<DRI>, mainSourcesetData: Set<DokkaConfiguration.DokkaSourceSet>, mainStyles: Set<Style>, mainExtra: PropertyContainer<ContentNode>)

Properties

mainDRI

val mainDRI: Set<DRI>

mainExtra

val mainExtra: PropertyContainer<ContentNode>

mainSourcesetData

val mainSourcesetData: Set<DokkaConfiguration.DokkaSourceSet>

mainStyles

val mainStyles: Set<Style>

Functions

annotationsBlock

open override fun PageContentBuilder.DocumentableContentBuilder.annotationsBlock(d: AnnotationTarget)

annotationsBlockWithIgnored

open fun PageContentBuilder.DocumentableContentBuilder.annotationsBlockWithIgnored(d: AnnotationTarget, ignored: Set<Annotations.Annotation>, renderAtStrategy: AtStrategy, listBrackets: Pair<Char, Char>, classExtension: String)

annotationsInline

open override fun PageContentBuilder.DocumentableContentBuilder.annotationsInline(d: AnnotationTarget)

annotationsInlineWithIgnored

open fun PageContentBuilder.DocumentableContentBuilder.annotationsInlineWithIgnored(d: AnnotationTarget, ignored: Set<Annotations.Annotation>, renderAtStrategy: AtStrategy, listBrackets: Pair<Char, Char>, classExtension: String)

block

fun <T : Documentable> block(name: String, level: Int, kind: Kind = ContentKind.Main, elements: Iterable<T>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, renderWhenEmpty: Boolean = false, needsSorting: Boolean = true, headers: List<ContentGroup> = emptyList(), needsAnchors: Boolean = false, operation: PageContentBuilder.DocumentableContentBuilder.(T) -> Unit)

booleanLiteral

fun booleanLiteral(value: Boolean)

breakLine

fun breakLine(sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData)

build

fun build(sourceSets: Set<DokkaConfiguration.DokkaSourceSet>, kind: Kind, styles: Set<Style>, extra: PropertyContainer<ContentNode>): ContentGroup

buildGroup

fun buildGroup(dri: Set<DRI> = mainDRI, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, kind: Kind = ContentKind.Main, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, block: PageContentBuilder.DocumentableContentBuilder.() -> Unit): ContentGroup

buildSignature

fun buildSignature(d: Documentable): List<ContentNode>

codeBlock

fun codeBlock(language: String = "", kind: Kind = ContentKind.Main, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, block: PageContentBuilder.DocumentableContentBuilder.() -> Unit)

codeInline

fun codeInline(language: String = "", kind: Kind = ContentKind.Main, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, block: PageContentBuilder.DocumentableContentBuilder.() -> Unit)

comment

fun comment(docTag: DocTag, kind: Kind = ContentKind.Comment, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra)

constant

fun constant(text: String)

contentForBrief

open override fun PageContentBuilder.DocumentableContentBuilder.contentForBrief(sourceSet: DokkaConfiguration.DokkaSourceSet, customTag: CustomTagWrapper)

Brief comment section, usually displayed as a summary/preview.

contentForDescription

open override fun PageContentBuilder.DocumentableContentBuilder.contentForDescription(sourceSet: DokkaConfiguration.DokkaSourceSet, customTag: CustomTagWrapper)

Full blown content description, most likely to be on a separate page dedicated to just one element (i.e one class/function), so any amount of detail should be fine.

cover

fun cover(text: String, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles + TextStyle.Cover, extra: PropertyContainer<ContentNode> = mainExtra, block: PageContentBuilder.DocumentableContentBuilder.() -> Unit = {})

descriptionList

fun descriptionList(kind: Kind = ContentKind.Main, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, operation: PageContentBuilder.ListBuilder.() -> Unit = {})

divergentGroup

fun divergentGroup(groupID: ContentDivergentGroup.GroupID, dri: Set<DRI> = mainDRI, kind: Kind = ContentKind.Main, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, implicitlySourceSetHinted: Boolean = true, block: PageContentBuilder.DivergentBuilder.() -> Unit)

firstParagraphComment

fun firstParagraphComment(content: DocTag, kind: Kind = ContentKind.Comment, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra)

firstSentenceComment

fun firstSentenceComment(content: DocTag, kind: Kind = ContentKind.Comment, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra)

group

fun group(dri: Set<DRI> = mainDRI, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, kind: Kind = ContentKind.Main, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, block: PageContentBuilder.DocumentableContentBuilder.() -> Unit)

header

fun header(level: Int, text: String, kind: Kind = ContentKind.Main, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, block: PageContentBuilder.DocumentableContentBuilder.() -> Unit = {})

keyword

fun keyword(text: String)

link

fun link(text: String, address: String, kind: Kind = ContentKind.Main, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra)

fun link(text: String, address: DRI, kind: Kind = ContentKind.Main, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra)

fun link(address: DRI, kind: Kind = ContentKind.Main, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, block: PageContentBuilder.DocumentableContentBuilder.() -> Unit)

linkNode

fun linkNode(text: String, address: DRI, dci: DCI = DCI(mainDRI, ContentKind.Main), sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra): ContentDRILink

list

fun <T> list(elements: List<T>, prefix: String = "", suffix: String = "", separator: String = ", ", sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, surroundingCharactersStyle: Set<Style> = mainStyles, separatorStyles: Set<Style> = mainStyles, operation: PageContentBuilder.DocumentableContentBuilder.(T) -> Unit)

multiBlock

fun <T : Pair<String, List<Documentable>>> multiBlock(name: String, level: Int, kind: Kind = ContentKind.Main, groupedElements: Iterable<T>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, renderWhenEmpty: Boolean = false, needsSorting: Boolean = true, headers: List<ContentGroup> = emptyList(), needsAnchors: Boolean = false, operation: PageContentBuilder.DocumentableContentBuilder.(String, List<Documentable>) -> Unit)

operator

fun operator(text: String)

orderedList

fun orderedList(kind: Kind = ContentKind.Main, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, operation: PageContentBuilder.ListBuilder.() -> Unit = {})

parametersBlock

open fun PageContentBuilder.DocumentableContentBuilder.parametersBlock(function: DFunction, paramBuilder: PageContentBuilder.DocumentableContentBuilder.(DParameter) -> Unit)

Builds a distinguishable function parameters block, so that it can be processed or custom rendered down the road.

punctuation

fun punctuation(text: String)

sourceSetDependentHint

fun sourceSetDependentHint(dri: Set<DRI> = mainDRI, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, kind: Kind = ContentKind.Main, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, block: PageContentBuilder.DocumentableContentBuilder.() -> Unit)

fun sourceSetDependentHint(dri: DRI, sourcesetData: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, kind: Kind = ContentKind.Main, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, block: PageContentBuilder.DocumentableContentBuilder.() -> Unit)

sourceSetDependentText

fun <T> sourceSetDependentText(value: SourceSetDependent<T>, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = value.keys, styles: Set<Style> = mainStyles, transform: (T) -> String)

stringLiteral

fun stringLiteral(text: String)

table

fun table(kind: Kind = ContentKind.Main, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, operation: PageContentBuilder.TableBuilder.() -> Unit = {})

text

fun text(text: String, kind: Kind = ContentKind.Main, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra)

toSignatureString

open fun PageContentBuilder.DocumentableContentBuilder.toSignatureString(a: Annotations.Annotation, renderAtStrategy: AtStrategy, listBrackets: Pair<Char, Char>, classExtension: String)

unaryPlus

operator fun Collection<ContentNode>.unaryPlus()

operator fun ContentNode.unaryPlus()

unorderedList

fun unorderedList(kind: Kind = ContentKind.Main, sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = mainSourcesetData, styles: Set<Style> = mainStyles, extra: PropertyContainer<ContentNode> = mainExtra, operation: PageContentBuilder.ListBuilder.() -> Unit = {})