Skip to content

build(core): fail javadoc build on warnings #949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bestbeforetoday merged 1 commit into from
Jun 17, 2026
Merged

build(core): fail javadoc build on warnings #949

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion core/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,10 +381,11 @@ tasks.named<Javadoc>("javadoc") {
exclude { spec -> generatedDirs.any { spec.file.toPath().startsWith(it) } }
source(fileTree(immuteableJavaDir) { include("**/*.java") })

// Keep normal behavior for main javadoc (warnings allowed to show/fail if you want)
// Fail the build if Javadoc linting finds any issues in the hand-written sources.
options {
require(this is StandardJavadocDocletOptions)
addBooleanOption("Xdoclint:all", true)
addBooleanOption("Xwerror", true)
encoding = "UTF-8"
setDestinationDir(rootProject.layout.buildDirectory.dir("docs/${version}/core").get().asFile)
addStringOption("overview", "${rootProject.projectDir}/core/src/main/javadoc/overview.html")
Expand Down
Loading