aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src/main/kotlin/resolvers/external/javadoc/JavadocExternalLocationProvider.kt
blob: 60aa540a68b718c0daa34c3085f1d2fdb257a532 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
package org.jetbrains.dokka.base.resolvers.external.javadoc

import org.jetbrains.dokka.base.resolvers.external.DefaultExternalLocationProvider
import org.jetbrains.dokka.base.resolvers.shared.ExternalDocumentation
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.utilities.htmlEscape

class JavadocExternalLocationProvider(
    externalDocumentation: ExternalDocumentation,
    val brackets: String,
    val separator: String,
    dokkaContext: DokkaContext
) : DefaultExternalLocationProvider(externalDocumentation, ".html", dokkaContext) {

    override fun resolve(dri: DRI): String? {
        val docURL = externalDocumentation.documentationURL.toString().removeSuffix("/") + "/"
        externalDocumentation.packageList.locations[dri.toString()]?.let { path -> return "$docURL$path" }

        val packageLink = dri.packageName?.replace(".", "/")
        if (dri.classNames == null) {
            return "$docURL$packageLink/package-summary$extension".htmlEscape()
        }
        val classLink = if (packageLink == null) "${dri.classNames}$extension" else "$packageLink/${dri.classNames}$extension"
        val callableChecked = dri.callable ?: return "$docURL$classLink".htmlEscape()

        return ("$docURL$classLink#" +
                callableChecked.name +
                "${brackets.first()}" +
                callableChecked.params.joinToString(separator) +
                "${brackets.last()}").htmlEscape()
    }
}