纯Kotlin项目用Dokka 1.7.20生成Markdown时[jvm]标签泛滥求助
Dokka生成Markdown文档出现[jvm]标签的原因及解决办法
原因
Dokka 1.7.20版本默认会给JVM平台的Kotlin元素打上[jvm]平台标签——哪怕是纯Kotlin项目,只要编译目标是JVM,就会自动添加这个标签,属于该版本的默认行为,用来标识元素对应的目标平台。
解决办法
方法1:全局禁用平台标签
在项目的build.gradle.kts中添加以下配置,覆盖Dokka的默认设置:
tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach { dokkaSourceSets.configureEach { perPackageOption { matchingRegex.set(".*") platform.set(null) } } }
方法2:针对Markdown输出单独配置
如果只想在GFM/Jekyll格式的文档中隐藏标签,可以针对性配置输出格式:
tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach { format.set("gfm") // 换成"jekyll"即可对应Jekyll格式 dokkaSourceSets.configureEach { perPackageOption { matchingRegex.set(".*") platform.set(null) } } }
方法3:升级Dokka版本
升级到1.8及以上版本的Dokka,后续版本优化了平台标签的显示逻辑,纯JVM项目里不会再频繁出现[jvm]标签。
内容的提问来源于stack exchange,提问作者Siddharth Bhatheja
相关产品推荐
相关产品推荐

