You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2022/09/24 21:28:00 UTC

[commons-numbers] branch master updated: Remove javadoc links to JDK.

This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-numbers.git


The following commit(s) were added to refs/heads/master by this push:
     new b04dbc11 Remove javadoc links to JDK.
b04dbc11 is described below

commit b04dbc113294b05be92a635429df0bc4d778a03c
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Sat Sep 24 22:20:04 2022 +0100

    Remove javadoc links to JDK.
    
    The links configured in CP create redirect warnings on JDK 17 which fail
    the build. JDK links are automatically added by the javadoc plugin based
    on the target version.
---
 pom.xml | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/pom.xml b/pom.xml
index cce4ce39..0482c12b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -356,12 +356,16 @@
         </configuration>
       </plugin>
       <plugin>
-      <!-- NOTE: javadoc config must also be set under <reporting> -->
+        <!-- NOTE: javadoc config must also be set under <reporting> -->
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
         <configuration>
+          <!-- Java API links configured in commons-parent create redirect warnings on JDK 17
+            and fail the build. The links are not required as detectJavaApiLink=true (default). -->
+          <links combine.self="override">
+          </links>
           <failOnWarnings>true</failOnWarnings>
-          <!--  Enable MathJax -->
+          <!-- Enable MathJax -->
           <additionalOptions>${doclint.javadoc.qualifier} ${allowscript.javadoc.qualifier} -header '&lt;script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/${numbers.mathjax.version}/MathJax.js?config=TeX-AMS-MML_HTMLorMML"&gt;&lt;/script&gt;'</additionalOptions>
         </configuration>
       </plugin>
@@ -490,8 +494,12 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
         <configuration>
+          <!-- Java API links configured in commons-parent create redirect warnings on JDK 17
+            and fail the build. The links are not required as detectJavaApiLink=true (default). -->
+          <links combine.self="override">
+          </links>
           <failOnWarnings>true</failOnWarnings>
-          <!--  Enable MathJax -->
+          <!-- Enable MathJax -->
           <additionalOptions>${doclint.javadoc.qualifier} ${allowscript.javadoc.qualifier} -header '&lt;script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/${numbers.mathjax.version}/MathJax.js?config=TeX-AMS-MML_HTMLorMML"&gt;&lt;/script&gt;'</additionalOptions>
         </configuration>
       </plugin>