kotlin - Dokka 使用完全限定的类名

Question

我正在使用 dokka 为我自动生成 javadoc。尽管当它遇到不是来 self 的项目的任何类时，它会使用完全限定的名称。

是否可以仅使用类名并让 dokka 为其提供链接？例如:

java.lang.String getName()

我希望 java.lang.String 有 String 链接到 Java doc

我的 gradle 配置:

ext.simpleName = project.name.substring(project.name.indexOf('-') + 1, project.name.size())

dokka {
    outputFormat = 'javadoc'
    outputDirectory = "${rootProject.buildDir}/javadoc/$project.ext.simpleName"
    linkMapping {
        dir = 'src/main/java'
        url = "https://github.com/mibac138/ArgParser/blob/master/$project.ext.simpleName/src/main/java"
    }
    linkMapping {
        dir = 'src/main/kotlin'
        url = "https://github.com/mibac138/ArgParser/blob/master/$project.ext.simpleName/src/main/kotlin"
    }
}

此外，linkMapping 到底是什么？我不确定它的作用。

Answer 1

要链接到第 3 方库，您应该使用指向 Oracle Java 文档的 externalDocumentationLink:

dokka{    
    externalDocumentationLink {
        url = new URL("https://docs.oracle.com/javase/8/docs/api/")
    }

如果您在同一个项目中使用 Kotlin 和 Java，则可能需要 Java 类的完全限定名称