抑制关于“没有文件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 documented members. Applies globally, also can be overridden by packageOptions reportNotDocumented = true ... // Allows to customize documentation generation options on a per-package basis // Repeat for multiple packageOptions packageOptions { ... reportUndocumented = true // Emit warnings about not documented members ... } } 

但我不想压制有关无证件的警告。 那也会一样糟糕。 我所要做的就是压制无证无识的警告,假设我故意不重复自己,不重复自己。

有谁知道是否有一个选项关闭警告只是为了override fun

为您的具体情况使用@suppress

 class MyAndroidActivity: Activity { /** @suppress */ override fun onCreate(savedInstanceState: Bundle?) { ... } } 

这样您将完全排除文档中的重写函数。

但是,如果您希望在文档中保留对API调用的引用,只需在元素附近添加一个空的联机文档字符串(它将禁用该警告):

 class MyAndroidActivity: Activity { /***/ override fun onCreate(savedInstanceState: Bundle?) { ... } }