This is an automated email from the ASF dual-hosted git repository. twolf pushed a commit to branch dev_3.0 in repository https://gitbox.apache.org/repos/asf/mina-sshd.git
commit 05e5777697f011c8908dcd36893efb3e8ef32082 Author: Thomas Wolf <tw...@apache.org> AuthorDate: Fri Aug 29 23:27:23 2025 +0200 Fix javadoc errors --- .../java/org/apache/sshd/client/config/hosts/HostConfigEntry.java | 4 ++-- .../src/main/java/org/apache/sshd/common/config/keys/KeyUtils.java | 2 -- .../config/keys/loader/openssh/OpenSSHKeyPairResourceParser.java | 1 - sshd-core/src/main/java/org/apache/sshd/common/channel/Window.java | 2 +- .../main/java/org/apache/sshd/common/session/ConnectionService.java | 4 ++-- .../java/org/apache/sshd/common/session/helpers/AbstractSession.java | 1 - 6 files changed, 5 insertions(+), 9 deletions(-) diff --git a/sshd-common/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java b/sshd-common/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java index 6263c369c..f810472c0 100644 --- a/sshd-common/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java +++ b/sshd-common/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java @@ -466,7 +466,7 @@ public class HostConfigEntry extends HostPatternsHolder implements MutableUserHo * @param props The {@link Map} of properties - ignored if {@code null}/empty * @return the target appender * @throws IOException - * @see #appendNonEmptyProperty(Appendable, String, Object) + * @see {@link #appendNonEmptyProperty(Appendable, String, List)} */ public static <A extends Appendable> A appendNonEmptyProperties(A sb, Map<String, List<String>> props) throws IOException { if (MapEntryUtils.isEmpty(props)) { @@ -498,7 +498,7 @@ public class HostConfigEntry extends HostPatternsHolder implements MutableUserHo * broken down to <U>individual</U> lines - one per value. * @return The target appender after having appended (or not) the value * @throws IOException - * @see #appendNonEmptyValues(Appendable, String, Object...) + * @see {@link #appendNonEmptyProperties(Appendable, Map)} */ public static <A extends Appendable> A appendNonEmptyProperty(A sb, String name, List<String> value) throws IOException { String key = ValidateUtils.checkNotNullAndNotEmpty(name, "No property name"); diff --git a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/KeyUtils.java b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/KeyUtils.java index 7522a1456..2babf02b7 100644 --- a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/KeyUtils.java +++ b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/KeyUtils.java @@ -355,7 +355,6 @@ public final class KeyUtils { * supports} * * @param decoder The (never {@code null}) {@link PublicKeyEntryDecoder<?, ?> decoder} to register - * @see #registerPublicKeyEntryDecoderForKeyType(String, PublicKeyEntryDecoder<?, ?>) */ public static void registerPublicKeyEntryDecoder(PublicKeyEntryDecoder<?, ?> decoder) { Objects.requireNonNull(decoder, "No decoder specified"); @@ -437,7 +436,6 @@ public final class KeyUtils { /** * @param key The {@link Key} (public or private) - ignored if {@code null} * @return The registered {@link PublicKeyEntryDecoder<?, ?>} for this key or {code null} if no match found - * @see #getPublicKeyEntryDecoder(Class) */ public static PublicKeyEntryDecoder<?, ?> getPublicKeyEntryDecoder(Key key) { if (key == null) { diff --git a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/loader/openssh/OpenSSHKeyPairResourceParser.java b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/loader/openssh/OpenSSHKeyPairResourceParser.java index e4de11a1a..107849cfd 100644 --- a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/loader/openssh/OpenSSHKeyPairResourceParser.java +++ b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/loader/openssh/OpenSSHKeyPairResourceParser.java @@ -388,7 +388,6 @@ public class OpenSSHKeyPairResourceParser extends AbstractKeyPairResourceParser /** * @param key The {@link Key} (public or private) - ignored if {@code null} * @return The registered {@link PrivateKeyEntryDecoder} for this key or {code null} if no match found - * @see #getPrivateKeyEntryDecoder(Class) */ public static PrivateKeyEntryDecoder<?, ?> getPrivateKeyEntryDecoder(Key key) { if (key == null) { diff --git a/sshd-core/src/main/java/org/apache/sshd/common/channel/Window.java b/sshd-core/src/main/java/org/apache/sshd/common/channel/Window.java index c5dd81981..00d743187 100644 --- a/sshd-core/src/main/java/org/apache/sshd/common/channel/Window.java +++ b/sshd-core/src/main/java/org/apache/sshd/common/channel/Window.java @@ -79,7 +79,7 @@ public abstract class Window extends AbstractLoggingBean implements ChannelHolde * * <pre> * long toConsume = ...; - * if (toConsume < window.getSize()) { + * if (toConsume < window.getSize()) { * window.consume(toConsume); // Might throw an exception if some other thread consumed some space already * } * </pre> diff --git a/sshd-core/src/main/java/org/apache/sshd/common/session/ConnectionService.java b/sshd-core/src/main/java/org/apache/sshd/common/session/ConnectionService.java index 67bb13f3f..6e4bbd9a2 100644 --- a/sshd-core/src/main/java/org/apache/sshd/common/session/ConnectionService.java +++ b/sshd-core/src/main/java/org/apache/sshd/common/session/ConnectionService.java @@ -120,11 +120,11 @@ public interface ConnectionService * {@link Buffer} to the given {@link ReplyHandler}, which may execute in a different thread. * * <dl> - * <dt>want-reply == true && replyHandler != null</dt> + * <dt>want-reply == true && replyHandler != null</dt> * <dd>The returned future is fulfilled with {@code null} when the request was sent, or with an exception if the * request could not be sent. The {@code replyHandler} is invoked once the reply is received, with the SSH reply * code and the data received.</dd> - * <dt>want-reply == true && replyHandler == null</dt> + * <dt>want-reply == true && replyHandler == null</dt> * <dd>The returned future is fulfilled with an exception if the request could not be sent, or a failure reply was * received. If a success reply was received, the future is fulfilled with the received data buffer.</dd> * <dt>want-reply == false</dt> diff --git a/sshd-core/src/main/java/org/apache/sshd/common/session/helpers/AbstractSession.java b/sshd-core/src/main/java/org/apache/sshd/common/session/helpers/AbstractSession.java index 6417b8741..ee914027e 100644 --- a/sshd-core/src/main/java/org/apache/sshd/common/session/helpers/AbstractSession.java +++ b/sshd-core/src/main/java/org/apache/sshd/common/session/helpers/AbstractSession.java @@ -392,7 +392,6 @@ public abstract class AbstractSession extends SessionHelper { * @param buffer The {@link Buffer} containing the packet - it may be re-used to generate the response once * request has been decoded * @throws Exception if an exception occurs while handling this packet. - * @see #doHandleMessage(Buffer) */ protected void handleMessage(Buffer buffer) throws Exception { int cmd = buffer.getUByte();