Skip to content

Commit

Permalink
build(javadoc): disable doclint messages about missing tags (#4938)
Browse files Browse the repository at this point in the history
  • Loading branch information
keturn authored Nov 15, 2021
1 parent ce8d34f commit 7f2f0ca
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions config/gradle/common.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,16 @@ spotbugsMain {
}
}

// TODO: Temporary until javadoc has been fixed for Java 8 everywhere
javadoc {
tasks.javadoc {
// Disable doclint messages about missing "@param" or "@return" tags.
options.addBooleanOption("Xdoclint:all,-missing", true)

// Omit package qualifiers for some of the most common types.
options.noQualifiers(
"java.lang", "java.util.*", "org.joml",
"org.terasology.engine.entitySystem.entity"
)

// TODO: Temporary until javadoc has been fixed for Java 8 everywhere
failOnError = false
}

0 comments on commit 7f2f0ca

Please sign in to comment.