I'm migrating to Dokka v2, and after reading the m...

# dokka

[Edoardo Luppi]

I'm migrating to Dokka v2, and after reading the migration steps there is still one point that's unclear.
I currently have

dokkaHtmlPartial {
  dependsOn(generateKotlinGrammarSource) // ANTLR task
}

in my sub-module build script.
What's the correct task to use in place of dokkaHtmlPartial for this specific case?

[Adam Semenenko]

Could you share more about the generateKotlinGrammarSource task? I guess it generates Kotlin source code?

Are there other tasks that have dependsOn(generateKotlinGrammarSource)? I suspect the buildscript will have something like tasks.kotlinCompile { dependsOn(generateKotlinGrammarSource) }...

[Edoardo Luppi]

I guess it generates Kotlin source code?

Correct!

The entire snippet is

withType<KotlinCompilationTask<*>>().configureEach {
  dependsOn(generateKotlinGrammarSource)
}

dokkaHtmlPartial {
  dependsOn(generateKotlinGrammarSource)
}

//
// The source JAR tasks must explicitly depend on the grammar generation
// to avoid Gradle complaining and erroring out
//

sourcesJar {
  dependsOn(generateKotlinGrammarSource)
}

kotlin.targets.configureEach {
  if (publishable) {
    named<Jar>("${targetName}SourcesJar") {
      dependsOn(generateKotlinGrammarSource)
    }
  }
}

[Adam Semenenko]

Hmmm okay, that makes sense. Let's make a quick fix first, but I think it'd be better to try to remove the manual dependsOn() so Gradle can infer the task dependencies properly.

Replace

dokkaHtmlPartial {
  dependsOn(generateKotlinGrammarSource) // ANTLR task
}

with

tasks.withType(org.jetbrains.dokka.gradle.tasks.DokkaGenerateTask.java).configureEach {
   dependsOn(generateKotlinGrammarSource)
}

(my Groovy is very underdeveloped so you might need to fix something)

[Adam Semenenko]

Alternatively, you could remove all of the manual `dependsOn()`s by passing the generateKotlinGrammarSource as a srcDir.

Assuming the generateKotlinGrammarSource task has an @OutputDirectory, then it should be as simple as this:

kotlin {
    sourceSets {
        main {
            kotlin.srcDir(generateKotlinGrammarSource)
        }
    }
}

Gradle will then recognise it needs to run the task to generate the source code, and all the task dependencies will be inferred automatically.

[Edoardo Luppi]

Oh it is registered as source dir already.

kotlin {
  sourceSets {
    commonMain {
      kotlin {
        srcDir(layout.buildDirectory.dir("generatedAntlr"))
      }
      ...

But Gradle didn't like it anyway at the time I set it up (1.9.24). Not sure if something has changed in the meantime.

[Adam Semenenko]

ah, but registering the dir without the task means Gradle doesn't know it needs to run the task. Try replacing it with this:

kotlin {
  sourceSets {
    commonMain {
      kotlin {
        srcDir(generateKotlinGrammarSource)
      }
      ...

[Edoardo Luppi]

Ahhhh! Sorry, I really didn't notice the difference in your snippet lol, thought it was the same.
Basically, if I pass the task directly I can remove the dependsOn from KotlinCompilationTask and DokkaGenerateTask?

[Adam Semenenko]

exactly!

[Edoardo Luppi]

Is it because the task defines an @OutputDirectory that Gradle infers it automatically?

[Adam Semenenko]

yes

[Edoardo Luppi]

Nice. Let me try it out.

[Adam Semenenko]

there are some Gradle docs about it here https://docs.gradle.org/8.14/userguide/lazy_configuration.html#working_with_task_dependencies_in_lazy_properties

[Edoardo Luppi]

Yup, it works as expected now! I wonder if the same simplification also applies to sourcesJar and kotlin.targets.

[Edoardo Luppi]

Looks like it does.

[Edoardo Luppi]

Thanks for the suggestion! Much better now.

[Adam Semenenko]

nice! Happy to hear it