Skip to content

Commit a4aa7dc

Browse files
committed
(doc) fix javadoc issues
1 parent 3309cc2 commit a4aa7dc

File tree

7 files changed

+31
-900
lines changed

7 files changed

+31
-900
lines changed

pom.xml

+3
Original file line numberDiff line numberDiff line change
@@ -418,6 +418,9 @@ under the License.
418418
<groupId>org.apache.maven.plugins</groupId>
419419
<artifactId>maven-javadoc-plugin</artifactId>
420420
<version>3.3.1</version>
421+
<configuration>
422+
<failOnWarnings>false</failOnWarnings>
423+
</configuration>
421424
</plugin>
422425
<plugin>
423426
<groupId>org.apache.maven.plugins</groupId>

src/main/java/org/apache/maven/plugins/javadoc/JavadocNoForkReport.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
/**
2828
* Generates documentation for the <code>Java code</code> in an <b>NON aggregator</b> project using the standard
2929
* <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/">Javadoc Tool</a>. Note that this
30-
* goal does require generation of sources before site generation, e.g. by invoking <tt>mvn clean deploy site</tt>.
30+
* goal does require generation of sources before site generation, e.g. by invoking {@code mvn clean deploy site}.
3131
*
3232
* @author <a href="mailto:[email protected]">Mirko Friedenhagen</a>
3333
* @since 2.10

src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ public boolean isExternalReport()
163163
*
164164
* <br>
165165
* The logic is the following:
166-
* <table summary="Can-generate-report Matrix">
166+
* <table><caption>Can-generate-report Matrix</caption>
167167
* <tbody>
168168
* <tr>
169169
* <th> isAggregator </th>

src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -541,7 +541,7 @@ else if ( StringUtils.isNotEmpty( out.getOutput() ) )
541541
/**
542542
* Parse the output for 'javadoc -J-version' and return the javadoc version recognized. <br>
543543
* Here are some output for 'javadoc -J-version' depending the JDK used:
544-
* <table summary="Output for 'javadoc -J-version' per JDK">
544+
* <table><caption>Output for 'javadoc -J-version' per JDK</caption>
545545
* <tr>
546546
* <th>JDK</th>
547547
* <th>Output for 'javadoc -J-version'</th>
@@ -575,7 +575,7 @@ else if ( StringUtils.isNotEmpty( out.getOutput() ) )
575575
* @param output for 'javadoc -J-version'
576576
* @return the version of the javadoc for the output, only digits and dots
577577
* @throws PatternSyntaxException if the output doesn't match with the output pattern
578-
* <tt>(?s).*?[^a-zA-Z]([0-9]+\\.?[0-9]*)(\\.([0-9]+))?.*</tt>.
578+
* {@code (?s).*?[^a-zA-Z]([0-9]+\\.?[0-9]*)(\\.([0-9]+))?.*}.
579579
* @throws IllegalArgumentException if the output is null
580580
*/
581581
protected static String extractJavadocVersion( String output )
@@ -616,7 +616,7 @@ protected static String extractJavadocVersion( String output )
616616
/**
617617
* Parse a memory string which be used in the JVM arguments <code>-Xms</code> or <code>-Xmx</code>. <br>
618618
* Here are some supported memory string depending the JDK used:
619-
* <table summary="Memory argument support per JDK">
619+
* <table><caption>Memory argument support per JDK</caption>
620620
* <tr>
621621
* <th>JDK</th>
622622
* <th>Memory argument support for <code>-Xms</code> or <code>-Xmx</code></th>

src/main/java/org/apache/maven/plugins/javadoc/TestJavadocNoForkReport.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
* Generates documentation for the <code>Java Test code</code> in an <b>NON aggregator</b> project using the standard
2929
* <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/">Javadoc Tool</a>. Note that this
3030
* goal does require generation of test sources before site generation, e.g. by invoking
31-
* <tt>mvn clean deploy site</tt>.
31+
* {@code mvn clean deploy site}.
3232
*
3333
* @author <a href="mailto:[email protected]">Mirko Friedenhagen</a>
3434
* @since 2.10

0 commit comments

Comments
 (0)