问题标签 [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 投票
2 回答
670 浏览

kotlin - 如何在 Kotlin 文档 Dokka/Kdoc 中转义符号?

我想添加这样的评论

但是 Dokka/Kdoc 将方括号内的内容解释为参考。当您在 IDE 中检查函数的文档或生成文档时,这会导致呈现错误的注释。如何在 Dokka/Kdoc 中转义方括号/其他符号?

0 投票
0 回答
10849 浏览

android - 错误:不兼容的类型:NonExistentClass 无法转换为注解 @error.NonExistentClass()

我正在尝试为我的项目生成 Doka 文档。在生成时,我收到了类似上面的错误。我搜索了很多,但无法解决这个问题。我也通过了这个链接。这里说这可能是一个与匕首相关的问题。我也尝试了这些所有解决方案,但对我不起作用。我在这里发布我所有的 Gradle 文件以进行更多说明。如果有人遇到此问题或知道解决方法,请发表评论。

项目摇篮:

应用程序摇篮:

图书馆等级:

错误:- 任务:库:kaptReleaseKotlin FAILED 错误:不兼容的类型:NonExistentClass 无法转换为注解@error.NonExistentClass()

0 投票
1 回答
238 浏览

sample - 从 dokka 文档中排除样本

我将 dokka 示例目录指向我的测试源,这样我就可以@sample在我的文档中引用测试方法并提供经过测试的示例。这行得通,除了现在 dokka 也为我的测试生成文档,这显然不是我想要的。

有没有办法避免这种情况?除了我引用的位之外,我不希望在我的文档中跟踪我的样本或测试@sample

0 投票
0 回答
44 浏览

android - 如何在 Dokka 中设置输出 html 全局语言属性?

如果我在使用英语作为系统语言的 PC 上运行 Dokka gradle 脚本,javadoc/kdoc html 文件<html lang="en">位于顶部,但如果我在系统语言设置为西班牙语的情况下执行此操作,它将替换为<html lang="es">任何地方。

Dokka 中是否有一个选项可以为输出 html 设置首选的全局内容语言?提前致谢。

我查看了官方的 Dooka 自述文件(此处),但我没有看到任何选项。

0 投票
1 回答
317 浏览

kotlin - 如何向 Kotlin Dokka 文档添加页脚?

我正在寻找一种在所有 Dokka 生成的文档的页脚中包含文本的方法。我没有看到 Dokka 的 Gradle 或 Maven 插件宣传此选项。

这可能吗?你能指点我一个样本吗?

0 投票
1 回答
752 浏览

android - Gradle同步文件每次都失败,实现Dokka

试图在代码中实现 Dokka,但一直运行到 Gradle 同步失败:在 org 类型的对象上找不到参数 [org.jetbrains.dokka:dokka-gradle-plugin:0.9.16-eap-2] 的方法 classpath()。 gradle.api.internal.artifacts.dsl.dependencies.DefaultDependencyHandler。

我试图查看其他人的解决方案,但它似乎不起作用。

https://github.com/Kotlin/dokka/issues/258

来自github的这个问题导致我堆栈

Dokka - 跳过为默认的 android 包生成 javadoc

这也不起作用

我试图改变

还添加

我尝试更改和添加不同的 ext.dokka_version 但似乎没有任何效果。我只是希望它能够运行以生成一些 KDOC。

0 投票
1 回答
425 浏览

kotlin - kotlin 项目的默认 buildDir

我正在尝试使用 dokka https://kotlinlang.org/docs/reference/kotlin-doc.html将文档添加到我的项目中

成功后我不太能弄清楚它们的javadocs位置./gradlew build.

它说他们应该在那里,$buildDir/javadoc但我不确定buidlDir指向哪里。

我的 build.gradle 文件是这样的:

我希望在正确的方向上有一两个指针。

谢谢!

0 投票
1 回答
1265 浏览

android - 无法确定任务 ':app:dokka' 的依赖关系

我正在尝试在我的 android 项目上使用 dokka 来生成 kdoc。但是当我运行脚本'modules:app [dokka]'时出现此错误:无法确定任务':app:dokka'的依赖关系。kotlin.KotlinNullPointerException(无错误消息)

我在我的 gradle 文件中添加了以下几行:

项目构建.gradle

应用程序构建.gradle

无法确定任务 ':app:dokka' 的依赖关系。kotlin.KotlinNullPointerException(无错误消息)

0 投票
1 回答
65 浏览

android - Gradle 任务在不调用的情况下启动

我正在尝试使用Dokka为 javadoc 和 kotlindoc构建 javadoc

当我尝试执行 taskA 时,taskB 也会被执行。

0 投票
1 回答
324 浏览

android - Dokka 失败:com.intellij.psi.impl.source.PsiClassImpl 无法转换为 com.intellij.psi.PsiJavaFile

我有一个生成 Android 人工制品(主要.aardokka.

随着最近的一些更改dokka开始因这个神秘的错误而失败:

任何帮助,将不胜感激。我目前似乎无法追踪其来源。