Revise configuration for javadoc Gradle tasks

Closes gh-34766
2025-04-16 11:52:01 +02:00
parent 9c13c6b695
commit f40d98668d
2 changed files with 16 additions and 17 deletions
--- 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 {