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

Question

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

我已经在用了

packageOptions {
  prefix = "android"
  suppress = true
}

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

或者还有其他我应该研究的 Kotlin 文档生成器吗？

Answer 1

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

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