(doc) fix javadoc issues

apache · Dec 12, 2021 · a4aa7dc · a4aa7dc
1 parent 3309cc2
commit a4aa7dc
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 900 deletions.
diff --git a/pom.xml b/pom.xml
@@ -418,6 +418,9 @@ under the License.
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-javadoc-plugin</artifactId>
           <version>3.3.1</version>
+          <configuration>
+            <failOnWarnings>false</failOnWarnings>
+          </configuration>
         </plugin>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>

diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocNoForkReport.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocNoForkReport.java
@@ -27,7 +27,7 @@
 /**
  * Generates documentation for the <code>Java code</code> in an <b>NON aggregator</b> project using the standard
  * <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/">Javadoc Tool</a>. Note that this
- * goal does require generation of sources before site generation, e.g. by invoking <tt>mvn clean deploy site</tt>.
+ * goal does require generation of sources before site generation, e.g. by invoking {@code mvn clean deploy site}.
  *
  * @author <a href="mailto:mfriedenhagen@apache.org">Mirko Friedenhagen</a>
  * @since 2.10

diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java
@@ -163,7 +163,7 @@ public boolean isExternalReport()
      *
      * <br>
      * The logic is the following:
-     * <table summary="Can-generate-report Matrix">
+     * <table><caption>Can-generate-report Matrix</caption>
      *   <tbody>
      *     <tr>
      *       <th> isAggregator </th>

diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java
@@ -541,7 +541,7 @@ else if ( StringUtils.isNotEmpty( out.getOutput() ) )
     /**
      * Parse the output for 'javadoc -J-version' and return the javadoc version recognized. <br>
      * Here are some output for 'javadoc -J-version' depending the JDK used:
-     * <table summary="Output for 'javadoc -J-version' per JDK">
+     * <table><caption>Output for 'javadoc -J-version' per JDK</caption>
      * <tr>
      * <th>JDK</th>
      * <th>Output for 'javadoc -J-version'</th>
@@ -575,7 +575,7 @@ else if ( StringUtils.isNotEmpty( out.getOutput() ) )
      * @param output for 'javadoc -J-version'
      * @return the version of the javadoc for the output, only digits and dots
      * @throws PatternSyntaxException if the output doesn't match with the output pattern
-     *             <tt>(?s).*?[^a-zA-Z]([0-9]+\\.?[0-9]*)(\\.([0-9]+))?.*</tt>.
+     *             {@code (?s).*?[^a-zA-Z]([0-9]+\\.?[0-9]*)(\\.([0-9]+))?.*}.
      * @throws IllegalArgumentException if the output is null
      */
     protected static String extractJavadocVersion( String output )
@@ -616,7 +616,7 @@ protected static String extractJavadocVersion( String output )
     /**
      * Parse a memory string which be used in the JVM arguments <code>-Xms</code> or <code>-Xmx</code>. <br>
      * Here are some supported memory string depending the JDK used:
-     * <table summary="Memory argument support per JDK">
+     * <table><caption>Memory argument support per JDK</caption>
      * <tr>
      * <th>JDK</th>
      * <th>Memory argument support for <code>-Xms</code> or <code>-Xmx</code></th>

diff --git a/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocNoForkReport.java b/src/main/java/org/apache/maven/plugins/javadoc/TestJavadocNoForkReport.java
@@ -28,7 +28,7 @@
  * Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
  * <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/">Javadoc Tool</a>. Note that this
  * goal does require generation of test sources before site generation, e.g. by invoking
- * <tt>mvn clean deploy site</tt>.
+ * {@code mvn clean deploy site}.
  *
  * @author <a href="mailto:mfriedenhagen@apache.org">Mirko Friedenhagen</a>
  * @since 2.10