Skip to content

Better definition of requireJavadoc task #452

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
mernst merged 5 commits into from
Dec 20, 2025
Merged

Better definition of requireJavadoc task #452

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
efa0185
Better definition `requireJavadoc` task
mernst Dec 12, 2025
f703403
Fix indentation
mernst Dec 12, 2025
c6f9147
Add `def` to task registration
mernst Dec 12, 2025
7a24849
Merge ../multi-version-control into requirejavadoc-gradle
mernst Dec 15, 2025
48b2eeb
No longer Java source version 8
mernst Dec 20, 2025
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
15 changes: 7 additions & 8 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ plugins {
}

repositories {
mavenLocal()
mavenCentral()
maven { url = "https://central.sonatype.com/repository/maven-snapshots/" }
gradlePluginPortal()
Expand Down Expand Up @@ -95,14 +96,11 @@ tasks.withType(JavaCompile).configureEach {
options.forkOptions.jvmArgs += "-Xmx6g"
options.compilerArgs << "-Werror"
// "-processing" avoids javac warning "No processor claimed any of these annotations".
// "-options" is because of JDK 21 warning "source value 8 is obsolete..."
if (isJava21orHigher) {
options.compilerArgs << "-Xlint:all,-processing,-options,-this-escape"
options.compilerArgs << "-Xlint:all,-processing,-this-escape"
} else {
options.compilerArgs << "-Xlint:all,-processing,-options"
options.compilerArgs << "-Xlint:all,-processing"
}
// // Only needed when debugging.
// options.compilerArgs << "-g"
}
if (isJava21orHigher) {
apply plugin: "net.ltgt.errorprone"
Expand Down Expand Up @@ -205,7 +203,7 @@ javadoc {
}
check.dependsOn(javadoc)

tasks.register("javadocWeb", DefaultTask) {
tasks.register("javadocWeb", Javadoc) {
description = "Upload API documentation to website."
dependsOn(javadocWebUpload, javadocWebChgrp, javadocWebChmod)
}
Expand Down Expand Up @@ -240,12 +238,13 @@ configurations {
dependencies {
requireJavadoc("org.plumelib:require-javadoc:2.0.0")
}
tasks.register("requireJavadoc", JavaExec) {
def requireJavadoc = tasks.register("requireJavadoc", JavaExec) {
group = "Documentation"
description = "Ensures that Javadoc documentation exists."
inputs.files(sourceSets.main.allJava)
mainClass = "org.plumelib.javadoc.RequireJavadoc"
classpath = configurations.requireJavadoc
args("src/main/java")
args(sourceSets.main.allJava.srcDirs.collect{it.getAbsolutePath()})
jvmArgs += [
"--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED",
"--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED",
Expand Down