Dokka renderer for Material for MkDocs/opensavvy.dokka.material.mkdocs.renderer3/DeferredLinkCommand

DeferredLinkCommand

class DeferredLinkCommand(val dri: DRI, val isInCodeBlock: Boolean, val isCode: Boolean)(source)

The current module doesn't know how to resolve this link.

For example, because this is a link to a class defined in another module.

The current module serializes a special marker in the documentation, and the aggregator plugin will re-attempt to resolve it later.

Constructors

DeferredLinkCommand

constructor(dri: DRI, isInCodeBlock: Boolean, isCode: Boolean)

Types

object Companion

Properties

val dri: DRI

val isCode: Boolean

Whether the link should be displayed as Markdown inline code.

val isInCodeBlock: Boolean

The value of RenderingContext.isInCodeBlock at the place where the link is inserted.

Functions

fun format(address: String, renderedLabel: String): String