Add option to fail doc when Javadoc throws a warning
Some checks failed
build-and-test / build (push) Failing after 1m21s
build-and-test / generate-javadoc (push) Failing after 1m25s
build-and-test / test (push) Successful in 1m26s

This commit is contained in:
JeremyStar™ 2024-08-18 19:34:15 +02:00
parent 736dbed1f3
commit eb108495ea
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
8 changed files with 8 additions and 0 deletions

View file

@ -79,6 +79,7 @@ javadoc {
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
setLocale("en_US") // setLocale("en_US") //
addStringOption("Xwerror", "-quiet") // Fail build on warning
setJFlags([ setJFlags([
"-Duser.language=en_US" // See above "-Duser.language=en_US" // See above

View file

@ -118,6 +118,7 @@ javadoc {
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
setLocale("en_US") // setLocale("en_US") //
addStringOption("Xwerror", "-quiet") // Fail build on warning
setJFlags([ setJFlags([
"-Duser.language=en_US" // See above "-Duser.language=en_US" // See above

View file

@ -56,6 +56,7 @@ tasks.register("javadocAll", Javadoc) {
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
setLocale("en_US") // setLocale("en_US") //
addStringOption("Xwerror", "-quiet") // Fail build on warning
setJFlags([ setJFlags([
"-Duser.language=en_US" // See above "-Duser.language=en_US" // See above

View file

@ -77,6 +77,7 @@ javadoc {
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
setLocale("en_US") // setLocale("en_US") //
addStringOption("Xwerror", "-quiet") // Fail build on warning
setJFlags([ setJFlags([
"-Duser.language=en_US" // See above "-Duser.language=en_US" // See above

View file

@ -112,6 +112,7 @@ javadoc {
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
setLocale("en_US") // setLocale("en_US") //
addStringOption("Xwerror", "-quiet") // Fail build on warning
setJFlags([ setJFlags([
"-Duser.language=en_US" // See above "-Duser.language=en_US" // See above

View file

@ -116,6 +116,7 @@ javadoc {
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
setLocale("en_US") // setLocale("en_US") //
addStringOption("Xwerror", "-quiet") // Fail build on warning
setJFlags([ setJFlags([
"-Duser.language=en_US" // See above "-Duser.language=en_US" // See above

View file

@ -113,6 +113,7 @@ javadoc {
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
setLocale("en_US") // setLocale("en_US") //
addStringOption("Xwerror", "-quiet") // Fail build on warning
setJFlags([ setJFlags([
"-Duser.language=en_US" // See above "-Duser.language=en_US" // See above

View file

@ -71,6 +71,7 @@ javadoc {
setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff setMemberLevel(JavadocMemberLevel.PUBLIC) // Only display public stuff
setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor setOverview("src/main/javadoc/overview.html") // We want a custom overview page to greet the visitor
setLocale("en_US") // setLocale("en_US") //
addStringOption("Xwerror", "-quiet") // Fail build on warning
setJFlags([ setJFlags([
"-Duser.language=en_US" // See above "-Duser.language=en_US" // See above