问题标签 [kotlin-dokka]

我正在尝试将示例代码添加到我的 API 参考中。

我遵循此处突出显示的模式https://androidessence.com/contributing-to-kotlin 能够创建我的示例项目并运行所有代码，复制 kotlin stdlib 源使用的 _sampleUtils。

我将我的模块配置为在 dokka 配置中包含示例。

该示例正确加载到该函数的文档中并显示在该文档中，并带有一个运行按钮。

但是，当我点击运行时，它会返回Unresolved reference库中的所有符号。它也无法从 _samplesUtils.kt 文件中找到 assertPrint 方法。

我在 Dokka 配置中没有看到任何其他设置，以使其包含正在记录的库的 jar 文件。

我正在尝试为我的 kotlin 代码生成文档。我的一些类和函数有 KDOC 注释。

我尝试像这样从 CLI 运行 dokka：

java -jar dokka-cli-1.4.20.jar

结果是：

警告：Dokka 1.4.* 是一个 alpha 项目进度：初始化插件加载插件：[] 加载：[

] 抑制：[

] PROGRESS: 有效性检查 PROGRESS: 创建文档模型 PROGRESS: Exiting Generation: Nothing to document PROGRESS:

=== 时间测量 ===

我试图执行这个：

• 在项目的文件夹中。
• 在 src 文件夹中
• 在具有 .kt 文件的第一个 src 子文件夹中

所有运行的结果都相似。

关于如何解决这个问题的任何想法？谢谢。

基于此页面，我已将以下内容添加到我的 pom.xml 中：

https://github.com/Kotlin/dokka#using-the-maven-plugin

pom.xml

当我运行该项目时，我收到以下错误：

未找到依赖项 'org.jetbrains.dokka:dokka-maven-plugin:0.9.19-dev-15'

未找到插件“org.jetbrains.dokka:dokka-maven-plugin:0.9.19-dev-15”

有人可以帮忙解决这个配置吗？提前致谢。

我试图让这个构建传递给 Travis，但 Gradle 在运行./gradlew :chronolens-test:dokkaJavadoc任务时内存不足。

当我在本地运行任务时，它通过了。我尝试增加 Gradle 内存（例如，在此提交中），但无济于事。根据Travis 文档，我相信我配置的环境至少应该有 7 GB 的 RAM，因此使用高达 2-3 GB 的 Gradle 应该不是问题（特别是因为它在本地使用相同的 RAM 设置传递）。

我不确定我做错了什么。关于如何使构建绿色的任何想法？

谢谢！

我已经尝试了几个小时让 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 还是很陌生。任何帮助或提示将不胜感激。

问题 如何只显示类中定义的函数？

截图

安装

• 操作系统：Windows
• 构建工具：Gradle v6.8.2
• Dokka 版本：1.4.20

附加上下文 请在我的 Android build.gradle 文件中指定我应该使用示例添加什么配置。有数百个我没有定义的函数使文档几乎无法使用。

上面显示的屏幕截图是为 Class 生成的。如您所见，应该只生成nice函数和onCreate文档：

这是我尝试过的：

我有这样的示例代码：

Dokka 配置（build.gradle）：

但输出页面是：

我想在我的文档中附加一个指向[JSONObject] 引用的文档链接

我做错了什么？

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

示例：具有这样的功能：

提供文档：

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

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

我的 Android 项目包含 2 个子模块：

在https://medium.com/@julesrosser/auto-generate-kotlin-android-documentation-with-dokka-382248c03283之后，我添加了

到build.gradlein myproject，我将 myapp 中的一个更改为：

现在，如果我执行 gradle dokkamyapp生成所有文档：

但是我想为mymodel没有android依赖项的模块生成文档。它已经有以下插件：

现在，如果我只添加apply plugin: 'org.jetbrains.dokka-android'与以前相同的dokka块，我可以看到模块已处理，但最终没有生成任何文档。如果我将dokka块放入android块中，我什至会收到一条错误消息。我怎样才能让 dokka 也为我的纯 kotlin 模块生成文档？

请问你能帮忙gradle吗？

我只需要为 com.example.kmpcorelib.repo 包生成文档。因为现在我生成了所有项目，而不仅仅是 repo 包中的类。