Skip to content

Commit 3057de7

Browse files
committed
Merge branch '6.2.x'
2 parents d8b05c7 + f40d986 commit 3057de7

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

Diff for: framework-api/framework-api.gradle

+3-2
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,9 @@ javadoc {
3131
destinationDir = project.java.docsDir.dir("javadoc-api").get().asFile
3232
splitIndex = true
3333
links(rootProject.ext.javadocLinks)
34-
addBooleanOption('Xdoclint:syntax,reference', true) // only check syntax and reference with doclint
35-
addBooleanOption('Werror', true) // fail build on Javadoc warnings
34+
// Check for 'syntax' and 'reference' during linting.
35+
addBooleanOption('Xdoclint:syntax,reference', true)
36+
addBooleanOption('Werror', true) // fail build on Javadoc warnings
3637
}
3738
maxMemory = "1024m"
3839
doFirst {

Diff for: gradle/spring-module.gradle

+22-13
Original file line numberDiff line numberDiff line change
@@ -70,19 +70,28 @@ normalization {
7070
javadoc {
7171
description = "Generates project-level javadoc for use in -javadoc jar"
7272

73-
options.encoding = "UTF-8"
74-
options.memberLevel = JavadocMemberLevel.PROTECTED
75-
options.author = true
76-
options.header = project.name
77-
options.use = true
78-
options.links(project.ext.javadocLinks)
79-
options.setOutputLevel(JavadocOutputLevel.QUIET)
80-
// Check for syntax during linting.
81-
options.addBooleanOption("Xdoclint:syntax", true)
82-
83-
// Suppress warnings due to cross-module @see and @link references.
84-
// Note that global 'api' task does display all warnings, and
85-
// checks for 'reference' on top of 'syntax'.
73+
options {
74+
encoding = "UTF-8"
75+
memberLevel = JavadocMemberLevel.PROTECTED
76+
author = true
77+
header = project.name
78+
use = true
79+
links(project.ext.javadocLinks)
80+
setOutputLevel(JavadocOutputLevel.QUIET)
81+
// Check for 'syntax' during linting. Note that the global
82+
// 'framework-api:javadoc' task checks for 'reference' in addition
83+
// to 'syntax'.
84+
addBooleanOption("Xdoclint:syntax,-reference", true)
85+
// With the javadoc tool on Java 24, it appears that the 'reference'
86+
// group is always active and the '-reference' flag is not honored.
87+
// Thus, we do NOT fail the build on Javadoc warnings due to
88+
// cross-module @see and @link references which are only reachable
89+
// when running the global 'framework-api:javadoc' task.
90+
addBooleanOption('Werror', false)
91+
}
92+
93+
// Attempt to suppress warnings due to cross-module @see and @link references.
94+
// Note that the global 'framework-api:javadoc' task displays all warnings.
8695
logging.captureStandardError LogLevel.INFO
8796
logging.captureStandardOutput LogLevel.INFO // suppress "## warnings" message
8897
}

0 commit comments

Comments
 (0)