From 2b5ebd06d858b0b076be773533625f068d8ce2e0 Mon Sep 17 00:00:00 2001
From: Artem Bilan <artem.bilan@broadcom.com>
Date: Mon, 5 Aug 2024 16:46:17 -0400
Subject: [PATCH] Use `io.freefair.aggregate-javadoc` plugin

(cherry picked from commit 8df5c43a76e189d22cea79d74504b81f65c34a6d)
---
 build.gradle | 37 +++++++++++++++++++++----------------
 1 file changed, 21 insertions(+), 16 deletions(-)

diff --git a/build.gradle b/build.gradle
index 193926ebe6..ff22cd3b07 100644
--- a/build.gradle
+++ b/build.gradle
@@ -24,6 +24,7 @@ plugins {
     id 'io.spring.antora.generate-antora-yml' version '0.0.1'
     id 'com.github.spotbugs' version '6.0.19'
     id 'com.google.protobuf' version '0.9.4' apply false
+    id 'io.freefair.aggregate-javadoc' version '8.6'
 }
 
 if (isCI) {
@@ -217,6 +218,11 @@ configure(javaProjects) { subproject ->
                 attribute(scopeAttribute, 'provided')
             }
         }
+
+        [compileClasspath, testCompileClasspath, testRuntimeClasspath].each {
+            it.extendsFrom(optional)
+            it.extendsFrom(provided)
+        }
     }
 
     components.java.with {
@@ -236,13 +242,6 @@ configure(javaProjects) { subproject ->
         }
     }
 
-    [configurations.optional, configurations.provided].each { scoped ->
-        sourceSets.all {
-            compileClasspath += scoped
-            runtimeClasspath += scoped
-        }
-    }
-
     java {
         withJavadocJar()
         withSourcesJar()
@@ -1113,15 +1112,19 @@ project('spring-integration-bom') {
     }
 }
 
-tasks.register('api', Javadoc) {
-    group = 'Documentation'
-    description = 'Generates aggregated Javadoc API documentation.'
+dependencies {
+    javaProjects.each {
+        javadoc it
+    }
+}
+
+javadoc {
     title = "${rootProject.description} ${version} API"
     options {
         encoding = 'UTF-8'
         memberLevel = JavadocMemberLevel.PROTECTED
         author = true
-        header = rootProject.description
+        header = project.description
         use = true
         overview = 'src/api/overview.html'
         splitIndex = true
@@ -1129,12 +1132,14 @@ tasks.register('api', Javadoc) {
         addBooleanOption('Xdoclint:syntax', true) // only check syntax with doclint
     }
 
-    source javaProjects.collect { project ->
-        project.sourceSets.main.allJava
-    }
-    destinationDir = new File('build', 'api')
+    destinationDir = file('build/api')
     classpath = files().from { files(javaProjects.collect { it.sourceSets.main.compileClasspath }) }
+}
 
+tasks.register('api') {
+    group = 'Documentation'
+    description = 'Generates aggregated Javadoc API documentation.'
+    dependsOn javadoc
 }
 
 dokkaHtmlMultiModule {
@@ -1191,7 +1196,7 @@ tasks.register('docsZip', Zip) {
         include 'changelog.txt'
     }
 
-    from(api) {
+    from(javadoc) {
         into 'api'
     }