问题标签 [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.
kotlin - 如何为文件添加顶级 KDoc？
有没有办法为 Kotlin 文件添加一段顶级 KDoc？
由于 Kotlin 在单个文件中支持多个变量、函数、类等，因此将文件作为一个整体进行记录是有意义的。但是，Documenting Kotlin Code - Kotlin Programming Language似乎对此没有任何说明。
kotlin - 在 iOS/XCode 的内置 .frameworks 中包含 Kotlin/Native KDocs 文档
我正在为 iOS 和 Android 开发一个 Kotlin/Native 库。
运行时，我得到了带有 Obj-C 标头./gradlew assemble的 release/debug 。.framework
我可以.framework很好地使用这些。但在 XCode 上使用代码时，我还想继续编写类和函数的文档。
如果我使用 KDoc 并记录我的代码：
将它带到我的 iOS 项目时，所有这些都丢失了。因为.frameworks 不携带 KDocs。
组装文件时，有什么方法可以将文档转移到 Obj-C 标头或其他辅助文件中.framework？也许我缺少一些 Gradle 配置？
maven - 如何在 Kotlin 代码上强制执行完整的文档
我应该使用什么插件或工具来对新的 Kotlin 代码强制执行完整的 kdoc 文档？Java 代码通过 checkstyle 和 Sun 的规则集进行检查，我需要一个 Kotlin 的类似物。
android - 无法使用 Dokka 生成 Kdoc
我正在尝试在 Android 项目中生成 KDoc 文档。以下是添加此功能的相关文件。
build.gradle（根级别）：
build.gradle（模块：应用程序）
后来，我./gradlew dokka从命令行运行。但是没有产生任何输出。以下是我得到的：
其实MainActivity里面有一个小demo脚本。我不确定为什么什么都没有生成。请让我知道我的配置是否正确。此外，拥有一个工作配置会很棒。
android - KDoc / Dokka：忽略子类中的继承方法
我正在使用 KDoc/Dokka 为 android 库生成文档。
我有一个自定义视图，它扩展了LinearLayout.
问题在于它LinearLayout包含数百个公共方法。Dokka 为所有这些方法生成空文档，即使我没有在我自己的代码中使用或覆盖它们。
这完全掩盖了我自己的任何方法，并使文档几乎毫无用处。
如何防止 dokka 为继承的方法生成文档？
android - Kotlin 生成 Kdoc 的问题
嗨，我在使用 Kdoc 时遇到了问题，所以我遵循了这个：https ://blog.jetbrains.com/kotlin/2020/08/dokka-preview-based-on-kotlin-1-4-0-rc/
我能够在 gradle 基础项目中添加插件，然后使用./gradlew dokkaHtml终端上的命令我能够生成文档。这是结果：
它工作得很好，但我不明白我没有在文档下列出所有类，因为它在我关注的链接中。我必须添加什么才能有这个漂亮的演示文稿？
我还有另一个问题，我有一个带有伴随对象的类，但没有显示这个，我一直在搜索，但我找不到任何关于如何在 Kdoc 中显示伴随对象的信息，如果有人可以帮助我的话?
java - 如何为 Kotlin 扩展函数的接收者添加 KDoc 注释（Java 中的第一个参数，Kotlin 中的 `this`）
考虑这个非扩展函数：
当我在 kotlin 和 java 中使用这个函数时，我可以看到它的参数名称：expression.
我还可以编写与扩展函数相同的功能：
当我以这种方式将它编写为扩展函数时，调用它的布尔值的参数名称（this函数内的变量，AKA 接收器）显示为$this$checkArguments. 如何为此参数添加 KDoc 文档注释？使用@param $this$checkArguments似乎没有记录它。
kotlin - KDoc 是否有最大行长？
在 JavaDoc 中，行数不得超过 80 个字符（不包括和等表达式的未显示部分{@code}）{@link}。KDoc 有行长限制吗？它肯定不是 80，因为我发现 stdlib 中的行长达 112 个字符。有人知道吗？
kotlin - dokka CLI 的问题 - “退出一代：没有什么可记录的”
我正在尝试为我的 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 子文件夹中
所有运行的结果都相似。
关于如何解决这个问题的任何想法？谢谢。
android - kotlin kdoc 中的参考资源不可点击
我想在我的 Javadoc 中提到一个从 java 转换为 Kotlin 的布局。在java中是：
这是可点击的，但是当我使用 android studio 工具转换这个类时。改为：
这是不可点击的。我怎样才能让它可点击？