Skip to content

Commit

Permalink
Re-enable javadoc links to Logback
Browse files Browse the repository at this point in the history
- javadoc links to Logback were not working anymore when generation javadoc with JDK8. Now that we switched to JDK 17, these links can be re-enabled.
- disable javadoc warnings about “missing javadoc comments” on public/protected methods and fields
  • Loading branch information
brenuart committed Feb 5, 2023
1 parent 490cc14 commit 489498b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 14 deletions.
16 changes: 3 additions & 13 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -553,25 +553,15 @@
<configuration>
<!-- Enable all validation checks except "accessibility"
-->
<doclint>all,-accessibility</doclint>
<doclint>all,-missing,-accessibility</doclint>

<!-- Setup links to external api docs
-->
<links>
<!-- Javadoc generation fails under Java8 because the Logback javadoc does not contain a
"package-list" index file anymore since version 1.3.0. It seems to work however with
Java 9 and 11.
Note: "package-list" has been replaced by "element-list" in Java 9... Newer jdk versions
seem to look for "element-list" first and fallback to "package-list".
A possible workaround is to build the project (and generate javadoc) using Java 9 instead
of 8. In the meantime links to Logback apidoc are commented.
<links>
<link>https://javadoc.io/doc/ch.qos.logback/logback-core/${logback.version}</link>
<link>https://javadoc.io/doc/ch.qos.logback/logback-classic/${logback.version}</link>
<link>https://javadoc.io/doc/ch.qos.logback/logback-access/${logback.version}</link>
-->

<link>https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-core/${jackson.version}</link>
<link>https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/${jackson.version}</link>
</links>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ private DestinationParser() {
* <p>
*
* For example, "host1.domain.com,host2.domain.com:5560"
* <p>
*
* @param destinations comma-separated list of destinations in the form of {@code hostName[:portNumber]}
* @param defaultPort the port number to use when a destination does not specify one explicitly
Expand Down

0 comments on commit 489498b

Please sign in to comment.