Gradle在buildSrc中无法识别Dokka插件的问题排查

问题根源 #

你在buildSrc的plugins块中引入Dokka插件，只是给buildSrc这个模块本身启用了Dokka文档生成功能，但并没有让buildSrc的代码能引用Dokka的API类。同时你缺少Gradle核心API的依赖，导致tasks、gradle等Gradle相关引用也无法解析。

修正步骤 #

修改buildSrc/build.gradle.kts，调整依赖配置如下：

plugins {
    `kotlin-dsl`
    id("org.jetbrains.kotlin.jvm") version "1.8.0"
    // 移除这里的Dokka插件，不需要给buildSrc本身应用该插件
}

repositories {
    mavenCentral()
}

dependencies {
    implementation(kotlin("stdlib"))
    // 添加Gradle核心API依赖，解决tasks、gradle等引用问题
    implementation(gradleApi())
    // 添加Dokka核心依赖，版本与你要使用的保持一致
    implementation("org.jetbrains.dokka:dokka-core:1.7.20")
    // 如果需要用到Dokka的其他模块（如dokka-base），按需添加
    // implementation("org.jetbrains.dokka:dokka-base:1.7.20")
}

额外注意事项 #

1. 确保你的buildSrc代码中正确导入Dokka相关包，比如在VisibilityDocSet.kt中添加：

   import org.jetbrains.dokka.*
   

2. 编写复用配置时，要基于Project对象扩展，比如configureDocumentation.kt应该写成：

   import org.jetbrains.dokka.DokkaExtension
   import org.jetbrains.dokka.gradle.DokkaTask
   import org.gradle.api.Project
   
   fun Project.configureDocumentation() {
       plugins.apply("org.jetbrains.dokka")
       extensions.configure<DokkaExtension> {
           dokkaSourceSets.named("main") {
               sourceRoots.from(file("src/main/kotlin"))
               reportUndocumented.set(true)
               skipEmptyPackages.set(true)
               documentedVisibilities.set(setOf(
                   org.jetbrains.dokka.DokkaVisibility.PUBLIC,
                   org.jetbrains.dokka.DokkaVisibility.PROTECTED
               ))
           }
       }
   }
   

   这样其他模块的构建脚本就可以直接调用configureDocumentation()来复用配置。

内容的提问来源于stack exchange，提问作者s12works