问题标签 [kdoc]

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 回答
3327 浏览

kotlin - 如何将粗体、斜体、下划线等格式添加到 Kotlin 文档 (KDoc)

我在官方 Kotlin 参考中找到了文档化 Kotlin 代码页面。

然而,我不知道如何突出显示文档的某些部分,例如,将其标记为斜体或粗体。

我是 Kotlin 的新手,来自 Java,之前只使用过 JavaDoc,我们在其中使用<i>HTML<b>标签来突出显示文档中的部分。

0 投票
0 回答
427 浏览

kotlin - 如何使用 KDoc 记录默认参数

是否有使用 KDoc 记录默认参数的语法,还是我应该手动进行?

0 投票
1 回答
235 浏览

kotlin - 使用 KDoc 记录 Ktor 路由

有谁知道记录 Ktor 路线的正确方法是什么,旨在在 KDoc 上显示它?例子:

好吧,如果可能的话,我该怎么做?我应该输入哪种类型的信息?如何在其他方面实现 Ktor 兼容性?(我有另一个自己制作的路由器用于其他用途)

0 投票
0 回答
43 浏览

kotlin - 记录 Kotlin 代码:如何创建表?

我已经阅读了这篇关于记录 Kotlin 代码的文章和这篇文章。我试过这段代码:

和这个:

我还尝试删除*字符:

但是什么也没发生。当我们编写大量代码时,文档很重要。

那么,你知道如何在 Kotlin 文档中创建表格吗?

0 投票
1 回答
165 浏览

android - 如何生成闭源 AAR 的公共 API 的 source.jar?

我们在 Kotlin 中开发了一个封闭源代码库,它作为 AAR 发布。不幸的是,我们的用户在 IDE 中看不到 KDoc(JavaDoc for Kotlin)。因此,我们只想发布公共 API 的源代码。内部和公共 API 可以通过那里的包foo.bar.api.*foo.bar.internal.*

gradle 3.4可以做到这一点吗?

我发现创建 Android 库 AAR,包括 javadoc 和源,但我们不想包括所有源。

0 投票
0 回答
286 浏览

java - 如何在 Java 类中继承 KDoc 文档?

我有带有 KDoc 的 Kotlin 类,例如:

此类由 Kotlin 和 Java 类扩展。KDoc 被 Kotlin 类正确继承。KDoc 在子类的 Intellij 中单击 Ctrl+Q 时显示。但是,如果子类是用 Java 编写的,则它不起作用。在这种情况下不继承 KDoc。

如何在 Java 中继承 KDoc?

0 投票
2 回答
670 浏览

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

我想添加这样的评论

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

0 投票
0 回答
44 浏览

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

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

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

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

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 投票
0 回答
168 浏览

android - 如何从类的 KDoc 中引用自定义属性?

我有一个自定义 View 类,在它的评论中,我想输入如下内容:

/**
* (...)
* 使用此视图时,请在布局中指定 [myView_screenName]。
*/

如果 KDoc 中的 [] 括号内是一个方法,Android Studio 会自动链接它,您可以轻松跳转到那里。

是否可以为自定义属性做类似的事情,即:从 KDoc 中引用它,以便跳转到相应的<declare-styleable>标签?
如果是这样,怎么做?