Skip to content

Commit d8840f3

Browse files
committed
Restore external documentation links for Dokka
- Restore external documentation links in spring-integration-core's `dokkaSourceSets` using the new `externalDocumentationLinks. register()` API instead of deprecated `externalDocumentationLink` - Fix indentation of spring-integration-core's `dokka` configuration block to be properly scoped within the project - Remove redundant `noJdkLink.set(false)` setting (false is default) - Remove unnecessary root-level `dokka` configuration that was setting module name and output directory without effect - Remove unused `dokkaGeneratePublicationHtml` task dependency from `docsZip` as `dokkaGenerate` already handles the generation - Simplify dependency chain by relying solely on `:spring-integration-core:dokkaGenerate` - Use root project var to determine root
1 parent 123215f commit d8840f3

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

build.gradle

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -511,14 +511,23 @@ project('spring-integration-core') {
511511
}
512512
}
513513

514-
dokka {
514+
dokka {
515515
dokkaPublications.html {
516-
outputDirectory.set(file('../build/kdoc'))
516+
outputDirectory.set(file(rootProject.layout.buildDirectory.file('kdoc')))
517517
}
518518
dokkaSourceSets.configureEach {
519-
noJdkLink.set(false)
520519
sourceRoots.setFrom(file('src/main/kotlin'))
521520
classpath.from(sourceSets['main'].runtimeClasspath)
521+
externalDocumentationLinks.register("spring-integration-api") {
522+
url.set(uri("https://docs.spring.io/spring-integration/docs/$version/api/"))
523+
packageListUrl.set(file('build/docs/javadoc/element-list').toURI())
524+
}
525+
externalDocumentationLinks.register("reactor-core") {
526+
url.set(uri('https://projectreactor.io/docs/core/release/api/'))
527+
}
528+
externalDocumentationLinks.register("reactor-streams") {
529+
url.set(uri('https://www.reactive-streams.org/reactive-streams-1.0.3-javadoc/'))
530+
}
522531
}
523532
}
524533

@@ -1088,17 +1097,6 @@ tasks.register('api') {
10881097
dependsOn javadoc
10891098
}
10901099

1091-
dokka {
1092-
moduleName.set('spring-integration')
1093-
dokkaPublications.html {
1094-
outputDirectory.set(file('build/kdoc'))
1095-
}
1096-
}
1097-
1098-
tasks.named('dokkaGeneratePublicationHtml') {
1099-
dependsOn 'api'
1100-
}
1101-
11021100
apply from: "${rootDir}/gradle/docs.gradle"
11031101

11041102
tasks.register('schemaZip', Zip) {
@@ -1137,7 +1135,6 @@ tasks.register('schemaZip', Zip) {
11371135
}
11381136

11391137
tasks.register('docsZip', Zip) {
1140-
dependsOn 'dokkaGeneratePublicationHtml'
11411138
dependsOn ':spring-integration-core:dokkaGenerate'
11421139
group = 'Distribution'
11431140
archiveClassifier = 'docs'

0 commit comments

Comments
 (0)