DocumentationReferencesTransformer

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

Functions

abstract fun onLink(link: DocumentationLink): DocumentationLink

Transforms a link, in the form of [link], within a KDoc documentation.

abstract fun onParam(param: Param, actualParameter: DParameter): Param

Transforms a parameter reference, in the form of @param paramName, within a KDoc documentation.

abstract fun onSee(see: See): See

Transforms a "see" reference, in the form of @see link, within a KDoc documentation.

Transforms references within a KDoc documentation.