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/11/01 12:10:43 UTC

[commons-rng] 01/02: Update javadoc plugin configuration

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-rng.git

commit 1902252dbd2e68baf37fed00b833361e9e81a111
Author: aherbert <ah...@apache.org>
AuthorDate: Tue Nov 1 11:59:20 2022 +0000

    Update javadoc plugin configuration
    
    Fix JDK 11 javadoc search pages.
    
    Use latest MathJax URL
---
 pom.xml | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git a/pom.xml b/pom.xml
index 04eb1453..c860546f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -57,6 +57,8 @@
     <maven.compiler.target>1.8</maven.compiler.target>
     <rng.revapi.version>0.14.7</rng.revapi.version>
     <rng.revapi.java.version>0.27.0</rng.revapi.java.version>
+    <!-- MathJax configuration also includes the prerequisite polyfill.min.js script.
+         See the maven-javadoc-plugin plugin. -->
     <rng.mathjax.url>https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js</rng.mathjax.url>
     <!-- Workaround to avoid duplicating config files. -->
     <rng.parent.dir>${basedir}</rng.parent.dir>
@@ -351,7 +353,18 @@
           </links>
           <failOnWarnings>true</failOnWarnings>
           <!-- Enable MathJax -->
-          <additionalOptions>${doclint.javadoc.qualifier} ${allowscript.javadoc.qualifier} -header '&lt;script type="text/javascript" async src="${rng.mathjax.url}"&gt;&lt;/script&gt;'</additionalOptions>
+          <additionalOptions>${doclint.javadoc.qualifier} ${allowscript.javadoc.qualifier} -header '&lt;script src="https://polyfill.io/v3/polyfill.min.js?features=es6"&gt;&lt;/script&gt;&lt;script type="text/javascript" async src="${rng.mathjax.url}"&gt;&lt;/script&gt;'</additionalOptions>
+          <!-- Fix for JDK 11 javadoc search:
+               https://stackoverflow.com/questions/52326318/maven-javadoc-search-redirects-to-undefined-url -->
+          <bottom>
+          <![CDATA[
+              <script>
+              if (typeof useModuleDirectories !== 'undefined') {
+                  useModuleDirectories = false;
+              }
+              </script>
+          ]]>
+          </bottom>
         </configuration>
       </plugin>
       <plugin>
@@ -461,7 +474,18 @@
           </links>
           <failOnWarnings>true</failOnWarnings>
           <!-- Enable MathJax -->
-          <additionalOptions>${doclint.javadoc.qualifier} ${allowscript.javadoc.qualifier} -header '&lt;script type="text/javascript" async src="${rng.mathjax.url}"&gt;&lt;/script&gt;'</additionalOptions>
+          <additionalOptions>${doclint.javadoc.qualifier} ${allowscript.javadoc.qualifier} -header '&lt;script src="https://polyfill.io/v3/polyfill.min.js?features=es6"&gt;&lt;/script&gt;&lt;script type="text/javascript" async src="${rng.mathjax.url}"&gt;&lt;/script&gt;'</additionalOptions>
+          <!-- Fix for JDK 11 javadoc search:
+               https://stackoverflow.com/questions/52326318/maven-javadoc-search-redirects-to-undefined-url -->
+          <bottom>
+          <![CDATA[
+              <script>
+              if (typeof useModuleDirectories !== 'undefined') {
+                  useModuleDirectories = false;
+              }
+              </script>
+          ]]>
+          </bottom>
         </configuration>
       </plugin>
       <plugin>