问题标签 [kotlin-dokka]

我想以自动方式验证我的 Kotlin 代码中的 Dokka/Kdoc 文档语法是否正确。

在我的 Java 代码中，我使用maven-compiler-plugin和/或maven-javadoc-plugin. 使用不正确的文档：

我得到：

这有助于我解决问题。

通过我的 Kotlin 代码，我使用dokka-maven-plugin. 使用不正确的文档：

没有错误或警告，甚至没有调试：

有什么方法/工具可以验证 Dokka/Kdoc 文档语法吗？

PS：理想情况下，我不想渲染耗时的 dokka html 文件，只需验证，即目标dokka-maven-plugin:validate会很棒。

谢谢！

错误：

如果我gradlePluginPortal()只使用：

一切都好。

我知道那是因为mavenrepo 没有dokka-core-1.5.0.jar，但为什么不下载gradlePluginPortal呢？

当我从 maven 导入我的库时，没有关于 Android Studio/IntelliSense 的可用文档。即使我正确设置了 Dokka 并且 javadoc.jar 存在于 maven repo 中，仍然无法使其工作。这是gradle脚本：

所有文档都在 Kdoc 中，我是否遗漏了什么？

提前致谢！

我只想为主包制作文档，所以我有名称为com.exam.device的包，但来自 dokka 的文档也为子包生成：com.exam.device.utils，com.exam.device.utils.breakdown，com .exam.device.list。我只需要为主包公开文档，我尝试了这个配置，但没有给出我想要的

有没有人遇到同样的问题？使用 Dokka 记录数据类时

文档在 Android Studio 中正确显示

但是，当使用 dokkaJavadoc 将库导出到 mavenLocal 时：

生成的库 javadoc 正确显示为方法，但不是数据类级别

注：html文档完整，仅针对Android Studio中显示的文档有问题。我没有找到任何其他关于这个问题的参考，这很奇怪，因为它对我来说看起来像是一个障碍。有什么线索吗？

我有一个带有 Kotlin 代码的模块，并且集成了 Dokka。

当我运行时，./gradlew :core:clean :core:dokkaHtml我会使用 Java 语法得到以下输出，而这段代码是纯 Kotlin：

为什么以及如何解决它？

我有一个名为“Machin”的模块，我想使用 ./gradlew ./gradlew dokkaHtml 生成 HTML 文档。它可以工作，但我的文档中有一些降价文件（.md），我想使用 Dokka 将其转换为 html。问题是只有一个 md 文件被转换，一个开头带有“# Module Machin”的文件正在工作并被转换为 index.html 文件。

在我的 build.gradle 中，我有：

我想为 Machin.md 生成一个 index.html，这很好用，但我也希望 Dokka 生成一个 GettingStarted.html 并希望 index.html 中的链接指向 GettingStarted.html。

我尝试使用 # Module Getting Started 并尝试使用这样的降价链接：

但是 Dokka 不会生成我的 GettingStarted.html，而且很明显，该链接不起作用。

有没有办法使用 Dokka 实现这一目标，还是不可能？

谢谢！

在常规的 Javadoc 生成过程中，我们可以通过添加以下行来简单地排除类或包。

exclude '**/SampleClass.java' exclude '**/com/example/java**'

问题：如何使用Dokka 工具排除/抑制单个 Kotlin/java 类？

下面是排除包的代码是否有排除特定类的选项？

Dokka 工具参考：https ://kotlinlang.org/docs/kotlin-doc.html

工具配置： https ://kotlin.github.io/dokka/1.5.0/user_guide/gradle/usage/#configuration-options