This is an automated email from the ASF dual-hosted git repository.
martijnvisser pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new 2ca359a140b [FLINK-36116] Update Javadoc plugin. This closes #25265
2ca359a140b is described below
commit 2ca359a140b99f8e94c192fc7775074138436dca
Author: Martijn Visser <[email protected]>
AuthorDate: Thu Aug 29 16:17:19 2024 +0200
[FLINK-36116] Update Javadoc plugin. This closes #25265
* [FLINK-36116] Update Javadoc plugin
The Javadoc needs to be updated since Javadoc generation fails with a
failed cast (com.sun.tools.javadoc.ClassDocImpl cannot be cast to
com.sun.javadoc.AnnotationTypeDoc)
* [FLINK-36116] Make Javadoc generation fail on errors
Failing to generate Javadocs should fail the documentation build, to avoid
that this issue goes undetected for a long period of time.
---
.github/workflows/docs.sh | 3 +--
pom.xml | 5 +++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/.github/workflows/docs.sh b/.github/workflows/docs.sh
index 1ce2661c552..5a3d933bc3f 100755
--- a/.github/workflows/docs.sh
+++ b/.github/workflows/docs.sh
@@ -52,8 +52,7 @@ mvn clean install -B -DskipTests -Dfast -Dskip.npm
-Pskip-webui-build
# build java/scala docs
mkdir -p docs/target/api
mvn javadoc:aggregate -B \
- -DadditionalJOption="-Xdoclint:none --allow-script-in-comments" \
- -Dmaven.javadoc.failOnError=false \
+ -Dmaven.javadoc.failOnError=true \
-Dcheckstyle.skip=true \
-Dspotless.check.skip=true \
-Denforcer.skip=true \
diff --git a/pom.xml b/pom.xml
index d4546a05f54..476af629bef 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2238,12 +2238,13 @@ under the License.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
-
<version>2.9.1</version><!--$NO-MVN-MAN-VER$-->
+ <version>3.8.0</version>
<configuration>
<quiet>true</quiet>
<detectOfflineLinks>false</detectOfflineLinks>
- <additionalJOptions
combine.children="append">
+ <additionalJOptions>
<additionalJOption>-Xdoclint:none</additionalJOption>
+
<additionalJOption>--allow-script-in-comments</additionalJOption>
</additionalJOptions>
</configuration>
</plugin>
