Докка использует полные имена классов
Я использую Dokka для автоматического создания Java doc для меня. Хотя, когда он встречает любой класс не из моего проекта, он использует полностью определенные имена.
Можно ли использовать только имена классов и заставить dokka предоставить ссылку для этого? Например:
java.lang.String getName()
Я бы хотел вместо java.lang.String
иметь String
со ссылкой на Java документ
Мой конфиг 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
? Я не уверен, что это делает.
1 ответ
Для ссылки на сторонние библиотеки вы должны использовать externalDocumentationLink
указывая на документацию Oracle Java:
dokka{
externalDocumentationLink {
url = new URL("https://docs.oracle.com/javase/8/docs/api/")
}
Если вы используете Kotlin и Java в одном проекте, могут потребоваться полные имена для классов Java