diff --git a/framework-api/framework-api.gradle b/framework-api/framework-api.gradle index c8456268c14..df7f3bbd57d 100644 --- a/framework-api/framework-api.gradle +++ b/framework-api/framework-api.gradle @@ -31,8 +31,9 @@ javadoc { destinationDir = project.java.docsDir.dir("javadoc-api").get().asFile splitIndex = true links(rootProject.ext.javadocLinks) - addBooleanOption('Xdoclint:syntax,reference', true) // only check syntax and reference with doclint - addBooleanOption('Werror', true) // fail build on Javadoc warnings + // Check for 'syntax' and 'reference' during linting. + addBooleanOption('Xdoclint:syntax,reference', true) + addBooleanOption('Werror', true) // fail build on Javadoc warnings } maxMemory = "1024m" doFirst { diff --git a/gradle/spring-module.gradle b/gradle/spring-module.gradle index 7d183af2f8c..c292f84349e 100644 --- a/gradle/spring-module.gradle +++ b/gradle/spring-module.gradle @@ -70,19 +70,28 @@ normalization { javadoc { description = "Generates project-level javadoc for use in -javadoc jar" - options.encoding = "UTF-8" - options.memberLevel = JavadocMemberLevel.PROTECTED - options.author = true - options.header = project.name - options.use = true - options.links(project.ext.javadocLinks) - options.setOutputLevel(JavadocOutputLevel.QUIET) - // Check for syntax during linting. - options.addBooleanOption("Xdoclint:syntax", true) - - // Suppress warnings due to cross-module @see and @link references. - // Note that global 'api' task does display all warnings, and - // checks for 'reference' on top of 'syntax'. + options { + encoding = "UTF-8" + memberLevel = JavadocMemberLevel.PROTECTED + author = true + header = project.name + use = true + links(project.ext.javadocLinks) + setOutputLevel(JavadocOutputLevel.QUIET) + // Check for 'syntax' during linting. Note that the global + // 'framework-api:javadoc' task checks for 'reference' in addition + // to 'syntax'. + addBooleanOption("Xdoclint:syntax,-reference", true) + // With the javadoc tool on Java 24, it appears that the 'reference' + // group is always active and the '-reference' flag is not honored. + // Thus, we do NOT fail the build on Javadoc warnings due to + // cross-module @see and @link references which are only reachable + // when running the global 'framework-api:javadoc' task. + addBooleanOption('Werror', false) + } + + // Attempt to suppress warnings due to cross-module @see and @link references. + // Note that the global 'framework-api:javadoc' task displays all warnings. logging.captureStandardError LogLevel.INFO logging.captureStandardOutput LogLevel.INFO // suppress "## warnings" message }