From 7f2f0ca82c7784e5a2a3d7a3c54051190d38ed6e Mon Sep 17 00:00:00 2001 From: Kevin Turner <83819+keturn@users.noreply.github.com> Date: Mon, 15 Nov 2021 13:39:17 -0800 Subject: [PATCH] build(javadoc): disable doclint messages about missing tags (#4938) --- config/gradle/common.gradle | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/config/gradle/common.gradle b/config/gradle/common.gradle index 784637f119d..302006bdd59 100644 --- a/config/gradle/common.gradle +++ b/config/gradle/common.gradle @@ -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 }