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

DocumentationMapper

interface DocumentationMapper

A fluent mapper for transforming documentation nodes.

Inheritors

Functions

Link copied to clipboard
open fun map(documentation: DokkaDocumentation): DokkaDocumentation

Maps a full documentation using the registered mappers.

abstract fun map(node: WithChildren<*>): WithChildren<*>

Maps a documentation node using the registered mappers.

Link copied to clipboard
abstract fun <T : WithChildren<*>> register(nodeType: KClass<T>, mapper: (T) -> WithChildren<*>): DocumentationMapper

Registers a mapper for a specific type of documentation node.