kotlin - 如何抑制特定类的 Dokka 文档？

Question

我正在尝试为我正在处理的库生成漂亮的 API 文档，但我还没有找到一种方法来阻止 Dokka 为生成的代码（如R我的包中的类）生成空文档页面。

我已经在使用

packageOptions {
  prefix = "android"
  suppress = true
}

在包级别抑制文档，但是有没有办法防止为我想要为其生成文档的包中的特定类生成文档？或者建立一个类的白名单，以便 Dokka 只为这些类生成文档？

或者是否有另一个我应该研究的 Kotlin 文档生成器？

Answer 1

看起来您可以在该packageOptions部分中指定类名和前缀。您只需像指定前缀一样指定它们。

packageOptions {
  prefix = "com.fqdn.MyPackage.R"
  suppress = true
}