Skip to content

Commit 7f2f0ca

Browse files
authored
build(javadoc): disable doclint messages about missing tags (#4938)
1 parent ce8d34f commit 7f2f0ca

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

config/gradle/common.gradle

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,16 @@ spotbugsMain {
119119
}
120120
}
121121

122-
// TODO: Temporary until javadoc has been fixed for Java 8 everywhere
123-
javadoc {
122+
tasks.javadoc {
123+
// Disable doclint messages about missing "@param" or "@return" tags.
124+
options.addBooleanOption("Xdoclint:all,-missing", true)
125+
126+
// Omit package qualifiers for some of the most common types.
127+
options.noQualifiers(
128+
"java.lang", "java.util.*", "org.joml",
129+
"org.terasology.engine.entitySystem.entity"
130+
)
131+
132+
// TODO: Temporary until javadoc has been fixed for Java 8 everywhere
124133
failOnError = false
125134
}

0 commit comments

Comments
 (0)