3

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

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

java.lang.String getName()

我想要而不是java.lang.String链接String到Java doc

我的毕业配置：

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什么？我不确定它的作用。

4

1 回答 1

2

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

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

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

于 2018-11-11T20:16:31.050 回答