base/org.jetbrains.dokka.base.resolvers.local/DokkaBaseLocationProvider

DokkaBaseLocationProvider

abstract class DokkaBaseLocationProvider(pageGraphRoot: RootPageNode, dokkaContext: DokkaContext) : DefaultLocationProvider

Inheritors

DokkaLocationProvider

Constructors

constructor(pageGraphRoot: RootPageNode, dokkaContext: DokkaContext)

Functions

ancestors

abstract fun ancestors(node: PageNode): List<PageNode>

anchorForDCI

open fun anchorForDCI(dci: DCI, sourceSets: Set<DisplaySourceSet>): String

Anchors should be unique and should contain sourcesets, dri and contentKind. The idea is to make them as short as possible and just use a hashCode from sourcesets in order to match the 2040 characters limit

expectedLocationForDri

open fun expectedLocationForDri(dri: DRI): String

This method should return guessed filesystem location for a given DRI It is used to decide if a DRI should be present in the relocation list of the generated package-list so it is ok if the path differs from the one returned by resolve

pathToRoot

abstract fun pathToRoot(from: PageNode): String

resolve

abstract fun resolve(dri: DRI, sourceSets: Set<DisplaySourceSet>, context: PageNode? = null): String?

abstract fun resolve(node: PageNode, context: PageNode? = null, skipExtension: Boolean = false): String?

resolveOrThrow

fun LocationProvider.resolveOrThrow(dri: DRI, sourceSets: Set<DisplaySourceSet>, context: PageNode? = null): String

fun LocationProvider.resolveOrThrow(node: PageNode, context: PageNode? = null, skipExtension: Boolean = false): String