Tag: 文档

抑制关于“没有文件com.foo.Bar $ toString()”的Dokka投诉?

我正在使用Gradle Dokka插件0.9.16-eap-1生成一些Kotlin代码的文档。 我是一个没有破窗户types的人,因此有点沮丧,插件生成吨的消息,我没有明确记录一个重写的方法,在基类中充分记录的类的消息, 例如 : package com.foo /** * A silly class to demonstrate silliness. */ class Bar : java.io.InputStream() { override fun read() = -1 override fun toString() = “BAZ!” } 对于这个class级,Dokka谴责: No documentation for com.foo.Bar$read() (Bar.kt:6) No documentation for com.foo.Bar$toString() (Bar.kt:7) 这有点乏味,因为我不想用复制粘贴文档冗余地冗余文档。 看看Dokka README.md ,我看到的唯一相关配置选项是: dokka { … // Emit warnings about not […]

在哪里/如何为Kotlin软件包添加文档?

在Java中,如果你想记录一个包,它必须放在package-info.class文件中。 Kotlin和KDoc仍然是一样的吗? 我已经浏览了Kotlin的一些源代码,并且找不到它们的包文档在哪里编写。

Kotlin Dokka’html-as-java’格式不生成java

我正在尝试使用Kotlin Dokka作为项目文档,并且工作正常,除了当我需要使用html-as-java格式。 我到目前为止尝试过其他格式,例如html和javadoc 。 这些按预期工作。 但是对于我来说html-as-java的结果似乎和html 。 有没有人遇到过这个问题? 也许我错过了一些东西。 谢谢