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

DefaultLocationProvider

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

Inheritors

Constructors

Link copied to clipboard
constructor(pageGraphRoot: RootPageNode, dokkaContext: DokkaContext)

Functions

Link copied to clipboard
abstract fun ancestors(node: PageNode): List<PageNode>
Link copied to clipboard
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

Link copied to clipboard
abstract fun pathToRoot(from: PageNode): String
Link copied to clipboard
abstract fun resolve(dri: DRI, sourceSets: Set<DisplaySourceSet>, context: PageNode? = null): String?
abstract fun resolve(node: PageNode, context: PageNode? = null, skipExtension: Boolean = false): String?
Link copied to clipboard
fun LocationProvider.resolveOrThrow(dri: DRI, sourceSets: Set<DisplaySourceSet>, context: PageNode? = null): String
fun LocationProvider.resolveOrThrow(node: PageNode, context: PageNode? = null, skipExtension: Boolean = false): String