问题标签 [kotlin-dokka]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
950 浏览

kotlin - 如何让 Dokka 生成可部署的 github wiki?

作为构建我的项目的一部分,我希望让 Dokka 的 maven 插件构建一个 markdown wiki,我可以在不修改的情况下部署到 github。我构建降价并通过 intellij 查看文档没有问题,但我希望将它直接托管在我项目的 github wiki 中。如果有人对如何做到这一点有任何想法,那就太好了。

这是我当前的 Dokka 配置

0 投票
2 回答
1032 浏览

kotlin - 如何在 Dokka 中制作嵌套列表?

尝试用非常常规的结构记录一些 Kotlin 代码:

  1. 编号列表。
    • 带有项目符号的子列表。
  2. 数字在列表顶层正确继续的位置。

我认为是Dokka 官方页面的页面上甚至没有“列表”一词。谷歌四处搜索,但没有找到任何有关如何执行此操作的信息。帮助!

0 投票
2 回答
199 浏览

kotlin-dokka - 如何在 dokka 的 fatjar 中使用多个源路径?

我正在使用 dokka 为多模块项目生成一些代码。我已经成功地能够使用他们的 cli fatjar 为单个模块生成文档,但该模块依赖于另一个模块。

让我注意,我启动的进程命令之间的唯一区别是源参数(尽管为了方便和 NDA 目的,我已经编辑了类路径之类的东西):

单模块

(在职的)

java -jar <path_to_jar>/dokka-fatjar-0.9.17.jar /<absolute_path1>/src -output docs -classpath <class_path>

多个来源

(甚至不分析并在输出目录中产生 0 结果)

java -jar <path_to_jar>/dokka-fatjar-0.9.17.jar /<absolute_path1>/src:/<absolute_path2>/src -output docs -classpath <class_path>

类路径最终完全相同(在项目构建代码中聚合它们之后)。

0 投票
0 回答
68 浏览

kotlin - 参考 Kotlin 文档中的 Spek 测试

我正在使用 kotlin Spek 测试框架,并希望在我的文档中链接到规范。但是当引用 Spec IntelliJ 时,它告诉我它没有找到 Spec。这是可以理解的,因为 Spec 位于测试根目录中。但是有没有办法链接到规范,例如通过添加到文件的链接或其他东西?

0 投票
1 回答
632 浏览

android - Android Dokka - Only generate docs for my code and skip everything else

I'm using Dokka v0.9.17 for Android. When I run ./gradlew dokka it generates the docs but it include so many packages that I don't care about like android.support.fragment and packages for all the third party libraries. How can I tell Dokka to only generate doc for my code?

How can I remove Dagger _Factory files from the doc?

My configuration is like this

0 投票
2 回答
531 浏览

maven - 插件本身不能添加 buildscript 依赖然后应用 dokka-android 插件

我们创建了GradleMavenPush插件,它执行将工件(Gradle Android Artifacts、Gradle Java Artifacts 和 Gradle Kotlin Artifacts)上传到 Maven 存储库(JCenter、Maven Central、企业登台/快照服务器和本地 Maven 存储库)

GradleMavenPush 插件本身不能添加 buildscript 依赖然后应用 dokka-android 插件:

未找到 ID 为“org.jetbrains.dokka-android”的插件。

来自插件本身的解决方案可以添加构建脚本依赖项然后应用插件吗?也不起作用:

未找到 ID 为“org.jetbrains.dokka-android”的插件。

你能提供任何帮助吗?

0 投票
1 回答
799 浏览

java - 如何将 Dokka 添加到 Android 项目而无需在依赖项部分添加额外的类路径?

如何在不向依赖项部分添加额外类路径的情况下将 Dokka 文档引擎支持添加到 Android 项目。我有兼容性问题...

Dokka 文档建议遵循,但它的类路径破坏了我的构建..

0 投票
0 回答
875 浏览

android - Kotlin Dokka - 加载包列表时出错

我正在尝试使用 Dokka 从我的 Kotlin 项目中生成文档。我正在使用 0.9.17 版本。

这是我的gradle配置:

要生成文档,我使用以下命令:

但是有一个问题(否则我不会问你^^)。我遇到的问题是:

我并不孤单,因为打开了一个错误,原因肯定是因为我在代理后面,但我不知道如何解决这个问题。

你有什么主意吗 ?

0 投票
1 回答
831 浏览

kotlin - 如何抑制特定类的 Dokka 文档?

我正在尝试为我正在处理的库生成漂亮的 API 文档,但我还没有找到一种方法来阻止 Dokka 为生成的代码(如R我的包中的类)生成空文档页面。

我已经在使用

在包级别抑制文档,但是有没有办法防止为我想要为其生成文档的包中的特定类生成文档?或者建立一个类的白名单,以便 Dokka 只为这些类生成文档?

或者是否有另一个我应该研究的 Kotlin 文档生成器?

0 投票
2 回答
6272 浏览

gradle - Gradle:在非 Android 项目上检测到不支持的模块

我在我的 gradle 项目中收到此警告/错误: Unsupported Modules Detected: Compilation is not supported for following modules: io.github.dogo-Dogo, Dogo_main, Dogo_test. Unfortunately you can't have non-Gradle Java modules and Android-Gradle modules in one project.

我对 Gradle 并不完全熟悉,我搜索了这样的错误,只是在 Android 环境中找到了这些东西,但我只使用了 Kotlin 和一些库。

那么,我该如何解决这个错误/警告信息?我不确定,但我认为当我添加 Dokka(Kotlin 文档工具)时它开始出现