root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Revise configuration for javadoc Gradle tasks
Backport Bot / build (push) Waiting to run Details
Build and Deploy Snapshot / Build and Deploy Snapshot (push) Waiting to run Details
Build and Deploy Snapshot / Verify (push) Blocked by required conditions Details
CI / ${{ matrix.os.name}} | Java ${{ matrix.java.version}} (map[toolchain:false version:17], map[id:ubuntu-latest name:Linux]) (push) Waiting to run Details
CI / ${{ matrix.os.name}} | Java ${{ matrix.java.version}} (map[toolchain:true version:21], map[id:ubuntu-latest name:Linux]) (push) Waiting to run Details
CI / ${{ matrix.os.name}} | Java ${{ matrix.java.version}} (map[toolchain:true version:23], map[id:ubuntu-latest name:Linux]) (push) Waiting to run Details
Deploy Docs / Dispatch docs deployment (push) Waiting to run Details 

Closes gh-34766
This commit is contained in:
Sam Brannen 2025-04-16 11:52:01 +02:00
parent 9c13c6b695
commit f40d98668d
2 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
framework-api/framework-api.gradle
View File

@ -31,8 +31,9 @@ javadoc {
destinationDir = project.java.docsDir.dir("javadoc-api").get().asFile destinationDir = project.java.docsDir.dir("javadoc-api").get().asFile
splitIndex = true splitIndex = true
links(rootProject.ext.javadocLinks) links(rootProject.ext.javadocLinks)
addBooleanOption('Xdoclint:syntax,reference', true) // only check syntax and reference with doclint // Check for 'syntax' and 'reference' during linting.
addBooleanOption('Werror', true) // fail build on Javadoc warnings addBooleanOption('Xdoclint:syntax,reference', true)
addBooleanOption('Werror', true) // fail build on Javadoc warnings
} }
maxMemory = "1024m" maxMemory = "1024m"
doFirst { doFirst {

28
gradle/spring-module.gradle
View File

@ -70,21 +70,19 @@ normalization {
javadoc { javadoc {
description = "Generates project-level javadoc for use in -javadoc jar" description = "Generates project-level javadoc for use in -javadoc jar"
options.encoding = "UTF-8" options {
options.memberLevel = JavadocMemberLevel.PROTECTED encoding = "UTF-8"
options.author = true memberLevel = JavadocMemberLevel.PROTECTED
options.header = project.name author = true
options.use = true header = project.name
options.links(project.ext.javadocLinks) use = true
// Check for syntax during linting. 'none' doesn't seem to work in suppressing links(project.ext.javadocLinks)
// all linting warnings all the time (see/link references most notably). // Check for 'syntax' during linting. Note that the global
options.addStringOption("Xdoclint:syntax", "-quiet") // 'framework-api:javadoc' task checks for 'reference' in addition
// to 'syntax'.
// Suppress warnings due to cross-module @see and @link references. addBooleanOption("Xdoclint:syntax,-reference", true)
// Note that global 'api' task does display all warnings, and addBooleanOption('Werror', true) // fail build on Javadoc warnings
// checks for 'reference' on top of 'syntax'. }
logging.captureStandardError LogLevel.INFO
logging.captureStandardOutput LogLevel.INFO // suppress "## warnings" message
} }
tasks.register('sourcesJar', Jar) { tasks.register('sourcesJar', Jar) {