问题标签 [kdoc]

问题 如何只显示类中定义的函数？

截图

安装

• 操作系统：Windows
• 构建工具：Gradle v6.8.2
• Dokka 版本：1.4.20

附加上下文 请在我的 Android build.gradle 文件中指定我应该使用示例添加什么配置。有数百个我没有定义的函数使文档几乎无法使用。

上面显示的屏幕截图是为 Class 生成的。如您所见，应该只生成nice函数和onCreate文档：

这是我尝试过的：

在 Java 中，我们有这样的东西：

点击链接采取不同的方法。

我可以在某种程度上实现第一个链接：

我还尝试了另一个示例（检查它是否不是侥幸）

我一直在 Android Studio 上尝试这些。Koltin 链接不可直接点击，但如果在“渲染视图”（使用 Ctrl+Alt+Q）中看到文档，则会显示链接。

我很难处理第二个 Java 示例。这不起作用：

如果有人解决了这个问题，请告诉我。谢谢。

背景

经过大量的研究和尝试，并寻求帮助，我已经成功地在 Jitpack 上使用 maven 发布了一个私有的 Github 存储库（写在这里）。

所以，目前我放在 Jitpack 存储库中的文件就是这些：

• jitpack.yml - 告诉使用哪些文件
• library-release.aar - （混淆的）代码本身
• pom-default.xml - 依赖项和其他一些配置。

问题

虽然依赖问题和 AAR 文件本身都很好，并且我可以使用该库，但我注意到我无法找到一种方法将我在那里编写的内容作为 KDoc（如 JavaDocs，但对于 Kotlin）提供给使用它的任何人。

我试过的

除了各种 gradle 任务，我还尝试了 Android Studio 本身的简单操作来制作它。由于没有提到 KDoc，我使用Tools->Generate JavaDocs代替。

可悲的是，它告诉我没有，而且确实在这里报道过。

但即使它确实成功了，我也不知道如何将它与其余文件一起发布。

问题

我希望这是可能的，但是如何在 Jitpack 上使用 maven 生成和公开 KDoc？

我想以自动方式验证我的 Kotlin 代码中的 Dokka/Kdoc 文档语法是否正确。

在我的 Java 代码中，我使用maven-compiler-plugin和/或maven-javadoc-plugin. 使用不正确的文档：

我得到：

这有助于我解决问题。

通过我的 Kotlin 代码，我使用dokka-maven-plugin. 使用不正确的文档：

没有错误或警告，甚至没有调试：

有什么方法/工具可以验证 Dokka/Kdoc 文档语法吗？

PS：理想情况下，我不想渲染耗时的 dokka html 文件，只需验证，即目标dokka-maven-plugin:validate会很棒。

谢谢！

我试图像@property 一样进行注释，但这是不对的。多卡不认识

例如枚举：

在我的 KDoc 评论中，我有一个链接，例如：

但是单击该链接不会在浏览器中打开该链接。我错过了什么吗？

在 JavaDoc 中，您可以像这样添加图像：

如何在 Kotlin Kdoc 中实现相同的目标？

当我从 maven 导入我的库时，没有关于 Android Studio/IntelliSense 的可用文档。即使我正确设置了 Dokka 并且 javadoc.jar 存在于 maven repo 中，仍然无法使其工作。这是gradle脚本：

所有文档都在 Kdoc 中，我是否遗漏了什么？

提前致谢！

对于测试功能，我留下了一个 KDoc 评论，引用了 GitHub 上某行代码的 URL：

如您所见，该 URL 很长（比项目的 detekt 策略允许的最大行长度长）。

现在我刚刚禁用了 KDoc 注释的 MaxLineLength detekt 规则：

但我想知道是否有可能满足规则而不破坏 KDoc 中的可点击 URL