Package-level declarations

Types

Link copied to clipboard

An implementation of DocumentationMapper that performs a deep mapping of documentation nodes down the node tree.

Link copied to clipboard

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.

Link copied to clipboard

A fluent mapper for transforming documentation nodes.

Link copied to clipboard

Entity that transforms references of org.jetbrains.dokka.model.Documentables within a KDoc documentation.

Link copied to clipboard
typealias DokkaDocumentation = Map<DokkaConfiguration.DokkaSourceSet, DocumentationNode>
Link copied to clipboard

A simple implementation of DocumentationMapper that performs a shallow mapping of documentation nodes.

Functions

Link copied to clipboard
fun buildDocTags(block: DocTagBuilder.() -> Unit): List<DocTag>

Builds a list of DocTags using the provided block via a DocTagBuilder DSL. This is a convenient function to create documentation tags in a more readable way.

Link copied to clipboard