Skip to content

Commit 05e5777

Browse files
committed
Fix javadoc errors
1 parent 52ff7a8 commit 05e5777

6 files changed

Lines changed: 5 additions & 9 deletions

File tree

sshd-common/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ private static String toKey(String name) {
466466
* @param props The {@link Map} of properties - ignored if {@code null}/empty
467467
* @return the target appender
468468
* @throws IOException
469-
* @see #appendNonEmptyProperty(Appendable, String, Object)
469+
* @see {@link #appendNonEmptyProperty(Appendable, String, List)}
470470
*/
471471
public static <A extends Appendable> A appendNonEmptyProperties(A sb, Map<String, List<String>> props) throws IOException {
472472
if (MapEntryUtils.isEmpty(props)) {
@@ -498,7 +498,7 @@ public static <A extends Appendable> A appendNonEmptyProperties(A sb, Map<String
498498
* broken down to <U>individual</U> lines - one per value.
499499
* @return The target appender after having appended (or not) the value
500500
* @throws IOException
501-
* @see #appendNonEmptyValues(Appendable, String, Object...)
501+
* @see {@link #appendNonEmptyProperties(Appendable, Map)}
502502
*/
503503
public static <A extends Appendable> A appendNonEmptyProperty(A sb, String name, List<String> value) throws IOException {
504504
String key = ValidateUtils.checkNotNullAndNotEmpty(name, "No property name");

sshd-common/src/main/java/org/apache/sshd/common/config/keys/KeyUtils.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,6 @@ public static KeyPair generateKeyPair(String keyType, int keySize) throws Genera
355355
* supports}
356356
*
357357
* @param decoder The (never {@code null}) {@link PublicKeyEntryDecoder<?, ?> decoder} to register
358-
* @see #registerPublicKeyEntryDecoderForKeyType(String, PublicKeyEntryDecoder<?, ?>)
359358
*/
360359
public static void registerPublicKeyEntryDecoder(PublicKeyEntryDecoder<?, ?> decoder) {
361360
Objects.requireNonNull(decoder, "No decoder specified");
@@ -437,7 +436,6 @@ public static Set<String> unregisterPublicKeyEntryDecoder(PublicKeyEntryDecoder<
437436
/**
438437
* @param key The {@link Key} (public or private) - ignored if {@code null}
439438
* @return The registered {@link PublicKeyEntryDecoder<?, ?>} for this key or {code null} if no match found
440-
* @see #getPublicKeyEntryDecoder(Class)
441439
*/
442440
public static PublicKeyEntryDecoder<?, ?> getPublicKeyEntryDecoder(Key key) {
443441
if (key == null) {

sshd-common/src/main/java/org/apache/sshd/common/config/keys/loader/openssh/OpenSSHKeyPairResourceParser.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,6 @@ public static void registerPrivateKeyEntryDecoder(PrivateKeyEntryDecoder<?, ?> d
388388
/**
389389
* @param key The {@link Key} (public or private) - ignored if {@code null}
390390
* @return The registered {@link PrivateKeyEntryDecoder} for this key or {code null} if no match found
391-
* @see #getPrivateKeyEntryDecoder(Class)
392391
*/
393392
public static PrivateKeyEntryDecoder<?, ?> getPrivateKeyEntryDecoder(Key key) {
394393
if (key == null) {

sshd-core/src/main/java/org/apache/sshd/common/channel/Window.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ public Channel getChannel() {
7979
*
8080
* <pre>
8181
* long toConsume = ...;
82-
* if (toConsume < window.getSize()) {
82+
* if (toConsume &lt; window.getSize()) {
8383
* window.consume(toConsume); // Might throw an exception if some other thread consumed some space already
8484
* }
8585
* </pre>

sshd-core/src/main/java/org/apache/sshd/common/session/ConnectionService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,11 +120,11 @@ default Buffer request(String request, Buffer buffer, Duration timeout) throws I
120120
* {@link Buffer} to the given {@link ReplyHandler}, which may execute in a different thread.
121121
*
122122
* <dl>
123-
* <dt>want-reply == true && replyHandler != null</dt>
123+
* <dt>want-reply == true &amp;&amp; replyHandler != null</dt>
124124
* <dd>The returned future is fulfilled with {@code null} when the request was sent, or with an exception if the
125125
* request could not be sent. The {@code replyHandler} is invoked once the reply is received, with the SSH reply
126126
* code and the data received.</dd>
127-
* <dt>want-reply == true && replyHandler == null</dt>
127+
* <dt>want-reply == true &amp;&amp; replyHandler == null</dt>
128128
* <dd>The returned future is fulfilled with an exception if the request could not be sent, or a failure reply was
129129
* received. If a success reply was received, the future is fulfilled with the received data buffer.</dd>
130130
* <dt>want-reply == false</dt>

sshd-core/src/main/java/org/apache/sshd/common/session/helpers/AbstractSession.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,6 @@ public MacInformation getMacInformation(boolean incoming) {
392392
* @param buffer The {@link Buffer} containing the packet - it may be re-used to generate the response once
393393
* request has been decoded
394394
* @throws Exception if an exception occurs while handling this packet.
395-
* @see #doHandleMessage(Buffer)
396395
*/
397396
protected void handleMessage(Buffer buffer) throws Exception {
398397
int cmd = buffer.getUByte();

0 commit comments

Comments
 (0)