问题标签 [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 回答
2541 浏览

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

我正在尝试使用 Dokka 插件为 android Kotlin 应用程序生成 Javadoc。我将插件添加到我的 gradle 中:

然后我按照项目说明进行了基本配置:

我使用基本的 gradle 命令生成文档:

输出很好,但它包括来自 android 的多个目录或我添加到项目中的插件,例如:

如何跳过这些包?有没有办法只为我的 /app/scr/java 文件夹和我创建的文件生成扩展坞?任何帮助表示赞赏。

0 投票
0 回答
560 浏览

intellij-idea - Dokka javadoc jar 不适用于 Intellij IDE

我在 build.gradle 文件中有以下配置:

这会生成外观正确的 javadoc jar ("${moduleName}-javadoc.jar")。但是,当使用 Intellij Idea 导入时,虽然它被检测为 javdoc jar,但 IDE 支持不起作用。是与 dokka-javadoc 格式不兼容还是 gradle 配置错误?

0 投票
1 回答
2318 浏览

kotlin - 如何使用 Kotlin Dokka 记录主构造函数参数

假设有一个类,其主构造函数具有param我想在类的 doc 块中解析的参数(链接到实际参数)。

但是,IDE 突出显示了该铭文param,说它无法解析 symbol param

0 投票
5 回答
4411 浏览

android - 在 Android Studio 3 中找不到 Dokka 插件

我正在尝试在我的 Kotlin 项目中使用 dokka 插件,但收到以下消息:

错误:(7, 0) 未找到 ID 为“org.jetbrains.dokka”的插件。

我正在使用 Android Studio 3.0 版。

提前致谢。

0 投票
2 回答
1080 浏览

inheritance - 禁止 Dokka 抱怨“没有 com.foo.Bar$toString() 的文档”?

我正在使用 Gradle Dokka 插件版本 0.9.16-eap-1 为一些 Kotlin 代码生成文档。

我是一个没有破窗的人,因此有点沮丧,因为插件为我没有明确记录在基类中充分记录的重写方法的类生成大量消息,例如

对于这堂课,Dokka 谴责:

这有点乏味,因为我不想用复制粘贴文档冗余地记录所有内容。

查看Dokka README.md,我看到的唯一相关配置选项是:

但我不想压制有关无证资料的警告。那也一样糟糕。我想做的就是压制关于无证override乐趣的警告,假设我故意不重复自己而不是重复自己。

有谁知道是否有一个选项可以关闭警告override fun

0 投票
0 回答
254 浏览

intellij-idea - 无法导航到 @sample 标记

在 Kotlin 的标准库中,我们Preconditions.kt使用了@sample标签:

是否有可能使这个标签在 IntelliJ 中可用?我的意思是查看samples.misc.Preconditions就地内容或使其可导航。我找不到任何应该添加到类路径以使其工作的依赖项。

0 投票
0 回答
926 浏览

kotlin - KDoc 注释未在 Dokka 生成的 HTML 中呈现

我目前正在测试 Dokka 文档,并且我所做的一些注释没有被呈现。以下是我的发现:

  1. 类不显示@sample,和 html 标签<p></p><h1></h1>:参见 SimpleCalculator类文档
  2. 如果描述在 html 标记下,则不会显示:参见enum class OPERATOR代码文档
  3. 方法不显示@sample并且根本不显示@property:查看所有方法代码文档
  4. @property和之间的混合定义@param。在类声明中, the@param是在 a 中的那个<>(例如Group<T>)。但在方法中,它是参数里面的那个。

请看我的代码:

我的顶级构建文件:

我的项目构建文件:

输出:

简单的计算器

枚举运算符

添加方法

有人可以帮忙吗?

0 投票
2 回答
1586 浏览

maven - 如何使用 dokka 生成用于存储库上传的 javadoc jar?

我最近将一个 java 组件迁移到了 kotlin。到目前为止,当我使用maven发布插件时,它也自动生成了javadoc,并且它也被上传到了oss.sonatype.com。另一方面,Dokka 似乎没有与开箱即用的发布插件集成。结果,上传到 oss.sonatype.com 后,nexus 拒绝发布并出现验证错误,因为缺少 javadoc jar。

关系验证结果

dokka 是否与 maven 发布插件集成?

0 投票
1 回答
362 浏览

kotlin-dokka - 未创建 Dokka 源链接

我正在开始开发一个新库,我想通过项目设置来启动项目,以使用 dokka 生成 API 文档。

我使用 gradle 作为构建工具,并将以下内容添加到我的build.gradle文件中:

当我运行gradlew dokka文档时,会正确创建文档,包括文件中的模块和包文档Modules.md。但是,我看不到 bitbucket 存储库的源链接。有人能告诉我如何从 dokka 获得更多关于为什么没有创建这些链接的信息吗?

0 投票
2 回答
1195 浏览

android - 在 Android Studio 中使用 Dokka 为 Kotlin 项目生成 Javadoc Kdoc 时出错

我正在使用Dokka插件为我的 kotlin 项目生成文档

这是插件网址https://github.com/Kotlin/dokka

我已按照说明进行操作,这就是我的Project.gradle的样子

这就是我的app/build.gradle 的样子

当我执行以下命令生成文档时

./gradlew dokka

它最初在该过程完成后下载了必要的 jar 文件,它给了我以下错误

不支持的 major.minor 版本 52.0

但我无法确定问题是什么或我在这里错过了什么

请帮我 ..