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

Question

我试图为我正在开发的库生成很好的API文档，而且我还没有找到一种方法来阻止Dokka为生成的代码生成空文档页，比如我的包中的R类。

我已经在用

packageOptions {
  prefix = "android"
  suppress = true
}

若要在包级别禁止文档，但是否有一种方法可以防止生成我希望为其生成文档的包中的特定类的文档？或者构建一个类的白名单，以便Dokka只为这些类生成文档？

还是有另一个我应该调查的Kotlin的文档生成器？

Answer 1

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

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

Answer 2

一种选择是将所需的类设置为internal。这样，就不会为内部文档生成文档。在gradle文件中配置dokka也很有用，如下所示：

    named("main"){
        //sourceRoots.setFrom(file("src/main/java/com/cujo/sb/util"))
        includeNonPublic.set(false)
        skipEmptyPackages.set(true)
        reportUndocumented.set(true)
        skipDeprecated.set(false)
    }