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

LocationProvider

Functions

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

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?

Inheritors

DefaultLocationProvider

Extensions

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