问题标签 [dokka]

考虑这个 Kotlin 类的类注释：

我希望第二个链接指向第二个函数（具有两个参数的函数）。

这在 Kotlin 文档语言中是否可行？

我已经使用Dokka for Android 项目成功生成了 Kotlin 文档。现在我如何发布到 Github Pages。

我正在慢慢地将我的库项目从 Java 迁移到 Kotlin。我有一个要求，我还需要为 has 中的库和 Android 仪器测试提供 Javadoc。我不能再使用 Javadoc，因为它在看到 *.kt 文件时会死掉。所以我转向Dokka。

我的问题是我可以使用 Dokka 轻松生成 Javadoc，但仅限于主要源代码集。但我无法让它为我的仪器测试生成文档。

我在库构建 gradle 中有以下配置：

在根 build.grade 我导入：

我究竟做错了什么？还是我误解了，我不能以这种方式生成单独的 Javadocs？我是否必须为所有构建变体生成扩展任务，例如：

编辑：似乎当我像这样为测试部分创建一个单独的任务时，它会这样做：

出于某种原因，我不得不去

否则它会忽略测试类。

此外，我仍然无法生成 Javadoc 版本，它会生成 HTML 版本。如果我添加

然后它只是忽略它

编辑2：

现在，我通过为测试创建第二个任务并将它们都保持为 HTML 格式来解决这个问题。例如：

Dokka 1.4.20 does not generate any documentation and returns the following for all tasks

build.gradle (Project)

It does generate the folders when using 1.4.20, but both command-line running as well as running the tasks in the Gradle panel do not work.

The documentation also specifies a bunch of things for configuration, but it is very unclear, and half of it gives me additional errors like setting the output directory.

I have tried version 0.9.17 as well, but with no success.

我已经尝试了几个小时让 dokka 在 gradle 下工作，但我找不到任何能够解决依赖关系的版本组合。例如

在我的 build.gradle 我有

根据https://mvnrepository.com/artifact/org.jetbrains.kotlinx/kotlinx-html-jvm/0.7.2它应该在https://dl.bintray.com/kotlin/kotlinx/但根据 Gradle，找不到。

虽然我已经使用 Maven 十多年了，但我对 Gradle 还是很陌生。任何帮助或提示将不胜感激。

开发 Kotlin/JS 项目，我们使用 Dokka Maven 插件生成 KDoc。然而，标准 JS 库类在生成的文档中显示为 ERROR CLASS。

示例：具有这样的功能：

提供文档：

我们在代理后面，Dokka 插件被配置为离线工作（<offlineMode>true</offlineMode>）。我们如何将 stdlib 文档链接到生成的文档？

编辑：似乎它与 Dokka Maven 插件有关，使用 Gradle 可以生成文档。

我正在为我的公共 API/函数生成文档。它运作良好。但现在我想在文档中也包含示例（示例代码）。我知道我们可以使用@sample 实现它，但不知何故我无法做到。

这是我的示例类，其中有示例代码。

}

这是 build.gradle 文件。

}

在生成的文档中，我只能在“Samples”标题下方看到“com.example.samples.Samples.doStuffSample”。我怎样才能做到这一点？任何帮助表示赞赏。

我有一个带有 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