问题标签 [kotlin-dokka]

我在这里看到了对KDoc的引用，KDoc 是 Kotlin 的 JavaDoc 实用程序等价物。

但是，我找不到任何关于如何使用它的文档，更不用说如何自定义它或将它集成到 Maven 或 Gradle 中了。

我知道Kotlin API 文档是使用 KDoc 生成的，因为页面源具有以下 HTML 注释：<!-- Generated by kdoc on Sun Jul 06 20:27:33 UTC 2014 -->

那么，是否有任何关于如何使用 KDoc 的文档可供参考？

既然 KDoc 文档生成引擎被Dokka 所取代，那么 Kotlin 文档应该被称为“KDoc 注释”还是“Dokka 注释”？

在 Java 中，如果你想记录一个包，它必须被放入 package-info.class 文件中。Kotlin 和 KDoc 还是一样吗？我查看了一些 Kotlin 源代码，但找不到他们的包文档是在哪里编写的。

我正在关注https://github.com/Kotlin/dokka中的 gradle 插件部分。

我还尝试了https://github.com/JetBrains/kotlin-examples/tree/master/gradle/dokka-gradle-example中的 dokka-gradle-example 示例。

我正在使用的版本是：

但我也尝试了从 0.9 到 0.9.7 的 Dokka 版本。

输出的相关部分是：

更新

我包括构建文件：

主要build.gradle：

模块app/build.gradle：

我在 IntelliJ 中有与上述类似的东西......但它会将导入识别为未使用- 因此优化导入将删除它......但是，如果我不手动插入该导入，那么在我的文档中它将识别 [MyClass .MyEnum]无法解析

我能做些什么？

在 Java 的 Javadoc 中，有一种方法可以使用{@inheritDoc}tag在子类中继承方法的文档。

有没有办法在 Kotlin 的 KDoc 中做同样的事情？

基本上，我想做的是以下几点：

对于两个给定的方法：

是否有可能复制/链接第二种方法的文档与第一种方法相同？

手动复制粘贴 KDOC 并不是很好，因为如果您更新其中一个，则第二个很可能会意外过时。

每当 Kotlin 和 Dokka 版本不兼容时，Gradle 和 Maven 构建中可能会出现奇怪的问题。我在任何地方都找不到两者之间的兼容版本列表。什么是版本兼容性？

注意： 这个问题是作者有意编写和回答的（Self-Answered Questions），因此常见的 Kotlin 主题的惯用答案出现在 SO 中。

我不知道如何kdoc在我的浏览器中观看生成的内容。

我正在使用 Kotlin 为 Android 开发，并在 gradle 中添加了 dokka 作为依赖项。
新dokka任务运行没有错误。

我在我的项目中添加了 dokka 作为依赖项build.gradle

并在我的应用程序中应用了插件build.gradle

但我在项目文件夹中找不到输出。如何在浏览器中观看输出或它在哪里？

谢谢

编辑1：IDE：Intellij；Kotlin 版本：1.1.1

编辑 2（11.04.2017）：

build.Gradle：

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

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

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

我的毕业配置：

另外，究竟是linkMapping什么？我不确定它的作用。