kotlin - 如何取消特定类(class)的Dokka文档?

标签 kotlin kotlin-dokka

我正在尝试为正在使用的库生成不错的API文档,但还没有找到一种方法来防止Dokka为生成的代码(如包中的R类)生成空文档页面。

我已经在用

packageOptions {
  prefix = "android"
  suppress = true
}

在包级别禁止显示文档,但是有什么方法可以防止为我要为其生成文档的包中的特定类生成文档?还是建立一个类的白名单,以便Dokka只为这些类生成文档?

还是我应该研究Kotlin的另一个文档生成器?

最佳答案

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

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

关于kotlin - 如何取消特定类(class)的Dokka文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/52669015/

相关文章:

gradle - 如何使用Gradle为打包文档配置Dokka?

在 Flowable 中使用方法引用时,Kotlin 无法推断类型

generics - 如何将 Kotlin 扩展函数参数约束为与扩展类型相同?

android - Jetpack Compose Navigation - 底部导航多个返回堆栈 - 查看模型范围问题

android - Android 3.5.3 上的 "Kotlin not configured"错误

kotlin - 如何向 Kotlin Dokka 文档添加页脚?

android - 如何将 Alexa 语音服务集成到自定义 Android 应用程序

android - KDoc/Dokka : Ignore inherited methods in subclass

java - 如何将 Dokka 添加到 Android 项目而不需要在依赖项部分添加额外的类路径?

kotlin - 将 KDoc 文档从一种方法复制到另一种方法