Dokka使用完全限定的类名

时间:2017-05-08 18:50:10

标签: kotlin kdoc kotlin-dokka

我正在使用dokka为我自动生成javadoc。虽然当它遇到任何不属于我的项目的类时,它使用完全限定的名称。

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

java.lang.String getName()

我想要而不是java.lang.StringString链接到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究竟是什么?我不确定它的作用。

1 个答案:

答案 0 :(得分:2)

要链接到第三方库,您应该使用 @objc func continueTapped() { ... continueButton.transform = CGAffineTransform(scaleX: 0.5, y: 0.5) UIView.animate(withDuration: 1.0, delay: 0, usingSpringWithDamping: 0.5, initialSpringVelocity: 1, options: .allowUserInteraction, animations: { [weak self] in self?.continueButton.transform = .identity let transition = CATransition() transition.duration = 0.5 transition.type = CATransitionType.push transition.subtype = CATransitionSubtype.fromRight transition.timingFunction = CAMediaTimingFunction(name:CAMediaTimingFunctionName.easeInEaseOut) self?.window!.layer.add(transition, forKey: kCATransition) self?.delegate?.didCompleteOnboarding() }, completion: { (success) in token = true defaults.set(token, forKey: "DidSee") }) } 指向Oracle Java文档:

externalDocumentationLink

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