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

Question

我正在尝试为我正在处理的库生成不错的 API 文档，但我还没有找到一种方法来防止 Dokka 为生成的代码生成空文档页面，例如 R class 在我的包里。

我已经在使用

packageOptions {
  prefix = "android"
  suppress = true
}

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

生成文档

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

Answer 1

您似乎可以在 packageOptions 部分指定 class 名称和前缀。您只需像指定前缀一样指定它们。

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