fix javadoc errors

ceki · ceki · commit 033aba489677 · 2026-01-17T20:48:48.000+01:00
diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/boolex/MarkerList.java b/logback-classic/src/main/java/ch/qos/logback/classic/boolex/MarkerList.java
@@ -19,7 +19,7 @@
 import java.util.List;
 
 /**
- * A helper class to be used in conjunction with {@link ch.qos.logback.classic.boolex.JaninoEventEvaluator}
+ * A helper class to be used in conjunction with <code>JaninoEventEvaluator</code> (removed in 1.5.13).
  *
  * @since 1.5.4
  */
diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/helpers/WithLayoutListAppender.java b/logback-classic/src/main/java/ch/qos/logback/classic/helpers/WithLayoutListAppender.java
@@ -24,7 +24,6 @@
  * An appender used for testing.
  * 
  * @author ceki
- * @param <E>
  * @since 1.3.0
  */
 public class WithLayoutListAppender extends AppenderBase<ILoggingEvent> {
diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/model/processor/ReceiverModelHandler.java b/logback-classic/src/main/java/ch/qos/logback/classic/model/processor/ReceiverModelHandler.java
@@ -24,7 +24,7 @@
 import ch.qos.logback.core.util.OptionHelper;
 
 /**
- * A Joran {@link ModelHandler} for a {@link SocketReceiver} configuration.
+ * A model handler for a {@link SocketReceiver} configuration.
  *
  * @author Carl Harris
  */
diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/net/SyslogAppender.java b/logback-classic/src/main/java/ch/qos/logback/classic/net/SyslogAppender.java
@@ -159,7 +159,7 @@ public void setThrowableExcluded(boolean throwableExcluded) {
     }
 
     /**
-     * See {@link #setStackTracePattern(String).
+     * See {@link #setStackTracePattern(String)}.
      *
      * @return the stackTraceSuffixPattern
      * @since 1.0.4
diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/selector/servlet/LoggerContextFilter.java b/logback-classic/src/main/java/ch/qos/logback/classic/selector/servlet/LoggerContextFilter.java
@@ -30,17 +30,24 @@
 import ch.qos.logback.classic.util.ContextSelectorStaticBinder;
 
 /**
- * A servlet filter that puts the environment dependent LoggerContext in a
+ * A servlet filter that puts the environment-dependent LoggerContext in a
  * ThreadLocal variable, removing it after the request is processed.
  * 
  * <p>
  * To use it, add the following lines to a web.xml file
- * 
- * <filter> <filter-name>LoggerContextFilter</filter-name> <filter-class>
- * ch.qos.logback.classic.selector.servlet.LoggerContextFilter </filter-class>
- * </filter> <filter-mapping> <filter-name>LoggerContextFilter</filter-name>
- * <url-pattern>/*</url-pattern> </filter-mapping>
- * 
+ * </p>
+ * <pre>
+  &lt;filter>
+    &lt;filter-name>LoggerContextFilter&lt;/filter-name>
+    &lt;filter-class>ch.qos.logback.classic.selector.servlet.LoggerContextFilter&lt;/filter-class>
+ &lt;/filter>
+
+ &lt;filter-mapping>
+   &lt;filter-name>LoggerContextFilter&lt;/filter-name>
+   &lt;url-pattern>/*&lt;/url-pattern>
+ &lt;/filter-mapping>
+ </pre>
+ *
  * @author S&eacute;bastien Pennec
  */
 public class LoggerContextFilter implements Filter {
diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/spi/Configurator.java b/logback-classic/src/main/java/ch/qos/logback/classic/spi/Configurator.java
@@ -24,7 +24,7 @@
  * in particular the no-arg constructor requirement.</p>
  *
  * <p>The return type of {@link #configure(LoggerContext)  configure} was changed from 'void' to
- * {@link ExecutionStatus) in logback version 1.3.0.
+ * {@link ExecutionStatus} in logback version 1.3.0.
  * </p>
  */
 public interface Configurator extends ContextAware {
diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/spi/IThrowableProxy.java b/logback-classic/src/main/java/ch/qos/logback/classic/spi/IThrowableProxy.java
@@ -44,7 +44,7 @@ default String getOverridingMessage() {
      * Is this instance the result of a cyclic exception?
      *
      * @return true if cyclic, false otherwise
-     * @sine 1.3.0
+     * @since 1.3.0
      */
     boolean isCyclic();
 }
diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/spi/PackagingDataCalculator.java b/logback-classic/src/main/java/ch/qos/logback/classic/spi/PackagingDataCalculator.java
@@ -21,7 +21,7 @@
  * Given a classname locate associated PackageInfo (jar name, version name).
  *
  * @author James Strachan
- * @Ceki G&uuml;lc&uuml;
+ * @author Ceki G&uuml;lc&uuml;
  */
 public class PackagingDataCalculator {
 
diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/turbo/DuplicateMessageFilter.java b/logback-classic/src/main/java/ch/qos/logback/classic/turbo/DuplicateMessageFilter.java
@@ -21,7 +21,7 @@
 
 /**
  * 
- * See {@link http://logback.qos.ch/manual/filters.html#DuplicateMessageFilter}
+ * See <a href=" http://logback.qos.ch/manual/filters.html#DuplicateMessageFilter">DuplicateMessageFilter</a>
  * for details.
  * 
  * @author Ceki Gulcu
diff --git a/logback-core/src/main/java/ch/qos/logback/core/hook/DefaultShutdownHook.java b/logback-core/src/main/java/ch/qos/logback/core/hook/DefaultShutdownHook.java
@@ -16,11 +16,11 @@
 import ch.qos.logback.core.util.Duration;
 
 /**
- * ShutdownHook implementation that <b>stops</b> the Logback context after a
- * specified delay. The default delay is 0 ms (zero).
+ * {@link ShutdownHook} implementation that <b>stops</b> the Logback context
+ * after a specified delay. The default delay is 0 ms (zero).
  * 
- * <p>
- * Stopping the logback context
+ * <p>Stopping the logback context
+ * </p>
  *
  * @author Mike Reinhold
  */
diff --git a/logback-core/src/main/java/ch/qos/logback/core/hook/package.html b/logback-core/src/main/java/ch/qos/logback/core/hook/package.html
@@ -10,7 +10,7 @@
 <p>Contains the shutdown hook functionality of logback,
 including the interface and base class for implementing 
 hooks as well as some default implementations, such as 
- {@link ch.qos.logback.core.hook.DelayingShutdownHook DelayingShutdownHook}
+ {@link ch.qos.logback.core.hook.DefaultShutdownHook DefaultShutdownHook}
 </p>
 
 </body>
diff --git a/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java b/logback-core/src/main/java/ch/qos/logback/core/joran/action/Action.java
@@ -59,7 +59,7 @@ public abstract void begin(SaxEventInterpretationContext intercon, String name,
     /**
      * Called to pass the body (as text) contained within an element.
      * 
-     * @param ic
+     * @param intercon
      * @param body
      * @throws ActionException
      */
diff --git a/logback-core/src/main/java/ch/qos/logback/core/joran/spi/ConsoleTarget.java b/logback-core/src/main/java/ch/qos/logback/core/joran/spi/ConsoleTarget.java
@@ -18,13 +18,13 @@
 
 /**
  * The set of console output targets.
- * 
+ *
+ * <p>See <a href="https://jira.qos.ch/browse/LOGBACK-136">LOGBACK-136</a></p>
+ *
  * @author Ruediger Dohna
  * @author Ceki G&uuml;lc&uuml;
  * @author Tom SH Liu
  * @author David Roussel
- * 
- * @sse LOGBACK-136
  */
 public enum ConsoleTarget {
 
diff --git a/logback-core/src/main/java/ch/qos/logback/core/net/ssl/SSLParametersConfiguration.java b/logback-core/src/main/java/ch/qos/logback/core/net/ssl/SSLParametersConfiguration.java
@@ -166,10 +166,11 @@ public String getIncludedProtocols() {
 
     /**
      * Sets the JSSE secure transport protocols to include.
-     * 
+     *
+     * <p>See Java Cryptography Architecture Standard Algorithm Name Documentation</p>
+     *
      * @param protocols a string containing comma-separated JSSE secure transport
      *                  protocol names
-     * @see Java Cryptography Architecture Standard Algorithm Name Documentation
      */
     public void setIncludedProtocols(String protocols) {
         this.includedProtocols = protocols;
@@ -187,10 +188,11 @@ public String getExcludedProtocols() {
 
     /**
      * Sets the JSSE secure transport protocols to exclude.
-     * 
+     *
+     * <p>See Java Cryptography Architecture Standard Algorithm Name Documentation</p>
+     *
      * @param protocols a string containing comma-separated JSSE secure transport
      *                  protocol names
-     * @see Java Cryptography Architecture Standard Algorithm Name Documentation
      */
     public void setExcludedProtocols(String protocols) {
         this.excludedProtocols = protocols;
@@ -208,10 +210,11 @@ public String getIncludedCipherSuites() {
 
     /**
      * Sets the JSSE cipher suite names to include.
-     * 
+     *
+     * <p>See Java Cryptography Architecture Standard Algorithm Name Documentation</p>
+     *
      * @param cipherSuites a string containing comma-separated JSSE cipher suite
      *                     names
-     * @see Java Cryptography Architecture Standard Algorithm Name Documentation
      */
     public void setIncludedCipherSuites(String cipherSuites) {
         this.includedCipherSuites = cipherSuites;
@@ -229,10 +232,12 @@ public String getExcludedCipherSuites() {
 
     /**
      * Sets the JSSE cipher suite names to exclude.
-     * 
+     *
+     * <p>See Java Cryptography Architecture Standard Algorithm Name Documentation</p>
+     *
      * @param cipherSuites a string containing comma-separated JSSE cipher suite
      *                     names
-     * @see Java Cryptography Architecture Standard Algorithm Name Documentation
+     *
      */
     public void setExcludedCipherSuites(String cipherSuites) {
         this.excludedCipherSuites = cipherSuites;
diff --git a/logback-core/src/main/java/ch/qos/logback/core/pattern/Converter.java b/logback-core/src/main/java/ch/qos/logback/core/pattern/Converter.java
@@ -16,7 +16,8 @@
 /**
  * A minimal converter which sets up the general interface for derived classes.
  * It also implements the functionality to chain converters in a linked list.
- * 
+ *
+ * @param <E> The type of the event object
  * @author ceki
  */
 abstract public class Converter<E> {
@@ -27,7 +28,7 @@ abstract public class Converter<E> {
      * The convert method is responsible for extracting data from the event and
      * storing it for later use by the write method.
      * 
-     * @param event
+     * @param event the event to convert
      */
     public abstract String convert(E event);
 
diff --git a/logback-core/src/main/java/ch/qos/logback/core/pattern/DynamicConverter.java b/logback-core/src/main/java/ch/qos/logback/core/pattern/DynamicConverter.java
@@ -23,7 +23,7 @@
 
 /**
  * As the name suggests, a DynamicConverter performs a conversion based on the parameter E
- * given to the {@link #convert(E)} method. Almost all converters are derived from the
+ * given to the {@link #convert} method. Almost all converters are derived from the
  * DynamicConverter class.
  *
  * @param <E>
diff --git a/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedFileNamingAndTriggeringPolicy.java b/logback-core/src/main/java/ch/qos/logback/core/rolling/TimeBasedFileNamingAndTriggeringPolicy.java
@@ -24,7 +24,7 @@
  * support methods.
  * </p>
  *
- * @See also {@link TimeBasedFileNamingAndTriggeringPolicyBase}
+ * @see TimeBasedFileNamingAndTriggeringPolicyBase
  *
  * @author Ceki G&uuml;lc&uuml;
  * 
diff --git a/logback-core/src/main/java/ch/qos/logback/core/rolling/helper/CompressionStrategy.java b/logback-core/src/main/java/ch/qos/logback/core/rolling/helper/CompressionStrategy.java
@@ -20,7 +20,7 @@
  * This interface was introduced in order to support for pluggable
  * compression methods.
  *
- * @author Ceki G&uuml;lc&uuml
+ * @author Ceki G&uuml;lc&uuml;
  * @since 1.5.18
  */
 public interface CompressionStrategy extends ContextAware {
diff --git a/logback-core/src/main/java/ch/qos/logback/core/rolling/helper/XZCompressionStrategy.java b/logback-core/src/main/java/ch/qos/logback/core/rolling/helper/XZCompressionStrategy.java
@@ -19,7 +19,7 @@
 import org.tukaani.xz.XZOutputStream;
 
 /**
- * Compresses files using {@link org.tukaani.xz xz} library.
+ * Compresses files using <a href="https://tukaani.org/xz/">tukaani.org/xz</a> library.
  *
  * <p>Note that </p>
  *
diff --git a/logback-core/src/main/java/ch/qos/logback/core/status/Status.java b/logback-core/src/main/java/ch/qos/logback/core/status/Status.java
@@ -32,8 +32,8 @@ public interface Status {
     Throwable getThrowable();
 
     /**
-     * @eprecated. Use getTimestamp instead.
-     * @return
+     * @deprecated Use getTimestamp instead.
+     * @return the date as a long value
      */
     @Deprecated
     default Long getDate() {
diff --git a/logback-core/src/main/java/ch/qos/logback/core/util/ExecutorServiceUtil.java b/logback-core/src/main/java/ch/qos/logback/core/util/ExecutorServiceUtil.java
@@ -99,7 +99,7 @@ static public void shutdown(ExecutorService executorService) {
     }
 
     /**
-     * An alternate implementation of {@linl #newThreadPoolExecutor} which returns a virtual thread per task executor when
+     * An alternate implementation of {@link #newThreadPoolExecutor} which returns a virtual thread per task executor when
      * available.
      *
      * @since 1.3.12/1.4.12
diff --git a/pom.xml b/pom.xml
@@ -422,7 +422,7 @@
 
           <links>
             <link>
-              http://docs.oracle.com/javase/7/docs/api/
+                https://docs.oracle.com/en/java/javase/11/docs/api/
             </link>
           </links>
 

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`import java.util.List;`
`20`	`20`
`21`	`21`	`/**`
`22`		`- * A helper class to be used in conjunction with {@link ch.qos.logback.classic.boolex.JaninoEventEvaluator}`
	`22`	`+ * A helper class to be used in conjunction with <code>JaninoEventEvaluator</code> (removed in 1.5.13).`
`23`	`23`	`*`
`24`	`24`	`* @since 1.5.4`
`25`	`25`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,6 @@`
`24`	`24`	`* An appender used for testing.`
`25`	`25`	`*`
`26`	`26`	`* @author ceki`
`27`		`- * @param <E>`
`28`	`27`	`* @since 1.3.0`
`29`	`28`	`*/`
`30`	`29`	`public class WithLayoutListAppender extends AppenderBase<ILoggingEvent> {`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`import ch.qos.logback.core.util.OptionHelper;`
`25`	`25`
`26`	`26`	`/**`
`27`		`- * A Joran {@link ModelHandler} for a {@link SocketReceiver} configuration.`
	`27`	`+ * A model handler for a {@link SocketReceiver} configuration.`
`28`	`28`	`*`
`29`	`29`	`* @author Carl Harris`
`30`	`30`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,7 @@ public void setThrowableExcluded(boolean throwableExcluded) {`
`159`	`159`	`}`
`160`	`160`
`161`	`161`	`/**`
`162`		`- * See {@link #setStackTracePattern(String).`
	`162`	`+ * See {@link #setStackTracePattern(String)}.`
`163`	`163`	`*`
`164`	`164`	`* @return the stackTraceSuffixPattern`
`165`	`165`	`* @since 1.0.4`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ default String getOverridingMessage() {`
`44`	`44`	`* Is this instance the result of a cyclic exception?`
`45`	`45`	`*`
`46`	`46`	`* @return true if cyclic, false otherwise`
`47`		`- * @sine 1.3.0`
	`47`	`+ * @since 1.3.0`
`48`	`48`	`*/`
`49`	`49`	`boolean isCyclic();`
`50`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`* Given a classname locate associated PackageInfo (jar name, version name).`
`22`	`22`	`*`
`23`	`23`	`* @author James Strachan`
`24`		`- * @Ceki Gülcü`
	`24`	`+ * @author Ceki Gülcü`
`25`	`25`	`*/`
`26`	`26`	`public class PackagingDataCalculator {`
`27`	`27`