From f40d98668da2cb91df22a508dc0b22c3ec91aba2 Mon Sep 17 00:00:00 2001 From: Sam Brannen <104798+sbrannen@users.noreply.github.com> Date: Wed, 16 Apr 2025 11:52:01 +0200 Subject: [PATCH] Revise configuration for javadoc Gradle tasks Closes gh-34766 --- framework-api/framework-api.gradle | 5 +++-- gradle/spring-module.gradle | 28 +++++++++++++--------------- 2 files changed, 16 insertions(+), 17 deletions(-) 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 33e0f6879eb..0fb2cfe2fef 100644 --- a/gradle/spring-module.gradle +++ b/gradle/spring-module.gradle @@ -70,21 +70,19 @@ 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) - // Check for syntax during linting. 'none' doesn't seem to work in suppressing - // all linting warnings all the time (see/link references most notably). - options.addStringOption("Xdoclint:syntax", "-quiet") - - // 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'. - logging.captureStandardError LogLevel.INFO - logging.captureStandardOutput LogLevel.INFO // suppress "## warnings" message + options { + encoding = "UTF-8" + memberLevel = JavadocMemberLevel.PROTECTED + author = true + header = project.name + use = true + links(project.ext.javadocLinks) + // 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) + addBooleanOption('Werror', true) // fail build on Javadoc warnings + } } tasks.register('sourcesJar', Jar) {