Add referenced modules to Javadoc classpath

Author: marcphilipp

gradle/plugins/common/src/main/kotlin/junitbuild.javadoc-conventions.gradle.kts

@@ -1,3 +1,5 @@
+import junitbuild.javadoc.JavadocConventionsExtension
+
 plugins {
 `java-library`
 }
@@ -6,23 +8,34 @@ java {
 withJavadocJar()
 }
 
+val javadocReference = configurations.dependencyScope("javadocReference")
+
+val extension = JavadocConventionsExtension(project, javadocReference.get(), tasks.javadoc)
+project.extensions.add("javadocConventions", extension)
+
+val javadocClasspath = configurations.resolvable("javadocClasspath") {
+extendsFrom(configurations.compileClasspath.get())
+extendsFrom(javadocReference.get())
+}
+
 tasks.javadoc {
+classpath = javadocClasspath.get()
 options {
 memberLevel = JavadocMemberLevel.PROTECTED
 header = project.name
 encoding = "UTF-8"
 locale = "en"
 (this as StandardJavadocDocletOptions).apply {
-addBooleanOption("Xdoclint:all,-missing,-reference", true)
+addBooleanOption("Xdoclint:all,-missing", true)
 addBooleanOption("html5", true)
- addMultilineStringsOption("tag").value = listOf(
- "apiNote:a:API Note:",
- "implNote:a:Implementation Note:"
- )
- use(true)
- noTimestamp(true)
- }
- }
+addMultilineStringsOption("tag").value = listOf(
+"apiNote:a:API Note:",
+"implNote:a:Implementation Note:"
+)
+use(true)
+noTimestamp(true)
+}
+}
 }
 
 tasks.named<Jar>("javadocJar").configure {

gradle/plugins/common/src/main/kotlin/junitbuild/javadoc/JavadocConventionsExtension.kt

@@ -0,0 +1,29 @@
+package junitbuild.javadoc
+
+import junitbuild.extensions.javaModuleName
+import org.gradle.api.Project
+import org.gradle.api.artifacts.Configuration
+import org.gradle.api.artifacts.ProjectDependency
+import org.gradle.api.tasks.TaskProvider
+import org.gradle.api.tasks.javadoc.Javadoc
+import org.gradle.external.javadoc.StandardJavadocDocletOptions
+import org.gradle.kotlin.dsl.dependencies
+
+class JavadocConventionsExtension(val project: Project, val dependencyScope: Configuration, val task: TaskProvider<Javadoc>) {
+
+ fun addExtraModuleReferences(vararg projectDependencies: ProjectDependency) {
+ project.dependencies {
+ projectDependencies.forEach { dependencyScope(it) }
+ }
+ task.configure {
+ options {
+ (this as StandardJavadocDocletOptions).apply {
+ val referencedModuleNames = projectDependencies.joinToString(",") { it.javaModuleName }
+ addStringOption("-add-modules", referencedModuleNames)
+ addStringOption("-add-reads", "${project.javaModuleName}=$referencedModuleNames")
+ }
+ }
+ }
+ }
+
+}

junit-jupiter-api/junit-jupiter-api.gradle.kts

@@ -24,6 +24,10 @@ dependencies {
 osgiVerification(projects.junitPlatformLauncher)
 }
 
+javadocConventions {
+addExtraModuleReferences(projects.junitPlatformEngine, projects.junitPlatformLauncher, projects.junitJupiterParams)
+}
+
 tasks {
 compileJava {
 options.compilerArgs.add("-Xlint:-module") // due to qualified exports

junit-platform-commons/junit-platform-commons.gradle.kts

@@ -21,6 +21,10 @@ dependencies {
 testFixturesImplementation(libs.assertj)
 }
 
+javadocConventions {
+addExtraModuleReferences(projects.junitPlatformEngine)
+}
+
 tasks.compileJava {
 options.compilerArgs.add("-Xlint:-module") // due to qualified exports
 val moduleName = javaModuleName

junit-platform-engine/junit-platform-engine.gradle.kts

@@ -19,3 +19,7 @@ dependencies {
 osgiVerification(projects.junitJupiterEngine)
 osgiVerification(projects.junitPlatformLauncher)
 }
+
+javadocConventions {
+addExtraModuleReferences(projects.junitPlatformLauncher)
+}

junit-platform-launcher/junit-platform-launcher.gradle.kts

@@ -16,6 +16,10 @@ dependencies {
 osgiVerification(projects.junitJupiterEngine)
 }
 
+javadocConventions {
+addExtraModuleReferences(projects.junitPlatformReporting)
+}
+
 tasks {
 jar {
 bundle {

junit-platform-suite-api/junit-platform-suite-api.gradle.kts

@@ -15,3 +15,7 @@ dependencies {
 osgiVerification(projects.junitJupiterEngine)
 osgiVerification(projects.junitPlatformLauncher)
 }
+
+javadocConventions {
+addExtraModuleReferences(projects.junitPlatformEngine, projects.junitPlatformLauncher)
+}