Skip to content

Commit 489498b

Browse files
committed
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
1 parent 490cc14 commit 489498b

File tree

2 files changed

+3
-14
lines changed

2 files changed

+3
-14
lines changed

pom.xml

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -553,25 +553,15 @@
553553
<configuration>
554554
<!-- Enable all validation checks except "accessibility"
555555
-->
556-
<doclint>all,-accessibility</doclint>
556+
<doclint>all,-missing,-accessibility</doclint>
557557

558558
<!-- Setup links to external api docs
559559
-->
560-
<links>
561-
<!-- Javadoc generation fails under Java8 because the Logback javadoc does not contain a
562-
"package-list" index file anymore since version 1.3.0. It seems to work however with
563-
Java 9 and 11.
564-
565-
Note: "package-list" has been replaced by "element-list" in Java 9... Newer jdk versions
566-
seem to look for "element-list" first and fallback to "package-list".
567-
568-
A possible workaround is to build the project (and generate javadoc) using Java 9 instead
569-
of 8. In the meantime links to Logback apidoc are commented.
570-
560+
<links>
571561
<link>https://javadoc.io/doc/ch.qos.logback/logback-core/${logback.version}</link>
572562
<link>https://javadoc.io/doc/ch.qos.logback/logback-classic/${logback.version}</link>
573563
<link>https://javadoc.io/doc/ch.qos.logback/logback-access/${logback.version}</link>
574-
-->
564+
575565
<link>https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-core/${jackson.version}</link>
576566
<link>https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/${jackson.version}</link>
577567
</links>

src/main/java/net/logstash/logback/appender/destination/DestinationParser.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ private DestinationParser() {
5555
* <p>
5656
*
5757
* For example, "host1.domain.com,host2.domain.com:5560"
58-
* <p>
5958
*
6059
* @param destinations comma-separated list of destinations in the form of {@code hostName[:portNumber]}
6160
* @param defaultPort the port number to use when a destination does not specify one explicitly

0 commit comments

Comments
 (0)