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

DefaultLocationProvider

abstract class DefaultLocationProvider(pageGraphRoot: RootPageNode, dokkaContext: DokkaContext) : LocationProvider
Content copied to clipboard

Constructors

Link copied to clipboard
fun DefaultLocationProvider(pageGraphRoot: RootPageNode, dokkaContext: DokkaContext)
Content copied to clipboard

Functions

Link copied to clipboard
abstract fun ancestors(node: PageNode): List<PageNode>
Content copied to clipboard
Link copied to clipboard
open fun expectedLocationForDri(dri: DRI): String
Content copied to clipboard

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
Content copied to clipboard
Link copied to clipboard
abstract fun resolve(    dri: DRI,     sourceSets: Set<DisplaySourceSet>,     context: PageNode? = null): String?
Content copied to clipboard
abstract fun resolve(    node: PageNode,     context: PageNode? = null,     skipExtension: Boolean = false): String?
Content copied to clipboard

Inheritors

Link copied to clipboard