Re-enable javadoc links to Logback

- 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
logfellow · Feb 5, 2023 · 489498b · 489498b
1 parent 490cc14
commit 489498b
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 14 deletions.
diff --git a/pom.xml b/pom.xml
@@ -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>

diff --git a/src/main/java/net/logstash/logback/appender/destination/DestinationParser.java b/src/main/java/net/logstash/logback/appender/destination/DestinationParser.java
@@ -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
-Original file 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 @@