This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-sshd.git
The following commit(s) were added to refs/heads/master by this push:
new 7820e0382 Fix 12 Javadoc warnings
7820e0382 is described below
commit 7820e03828ac44f1febcc3ecfa9fa8a0536371dd
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Jul 6 08:51:45 2023 -0400
Fix 12 Javadoc warnings
12 warnings
[WARNING] Javadoc Warnings
[WARNING]
C:\Users\ggregory\git\a\mina-sshd\sshd-common\src\main\java\org\apache\sshd\common\future\WaitableFuture.java:49:
warning - Tag @see: can't find await(long) in
org.apache.sshd.common.future.WaitableFuture
[WARNING]
C:\Users\ggregory\git\a\mina-sshd\sshd-common\src\main\java\org\apache\sshd\common\future\WaitableFuture.java:64:
warning - Tag @see: can't find await(long) in
org.apache.sshd.common.future.WaitableFuture
[WARNING]
C:\Users\ggregory\git\a\mina-sshd\sshd-common\src\main\java\org\apache\sshd\common\future\WaitableFuture.java:78:
warning - Tag @see: can't find await(long) in
org.apache.sshd.common.future.WaitableFuture
[WARNING]
C:\Users\ggregory\git\a\mina-sshd\sshd-common\src\main\java\org\apache\sshd\common\future\WaitableFuture.java:102:
warning - Tag @see: can't find awaitUninterruptibly(long) in
org.apache.sshd.common.future.WaitableFuture
[WARNING]
C:\Users\ggregory\git\a\mina-sshd\sshd-common\src\main\java\org\apache\sshd\common\future\WaitableFuture.java:116:
warning - Tag @see: can't find awaitUninterruptibly(long) in
org.apache.sshd.common.future.WaitableFuture
[WARNING]
C:\Users\ggregory\git\a\mina-sshd\sshd-common\src\main\java\org\apache\sshd\common\future\VerifiableFuture.java:44:
warning - Tag @see: can't find verify(long) in
org.apache.sshd.common.future.VerifiableFuture
[WARNING]
C:\Users\ggregory\git\a\mina-sshd\sshd-common\src\main\java\org\apache\sshd\common\future\VerifiableFuture.java:59:
warning - Tag @see: can't find verify(long) in
org.apache.sshd.common.future.VerifiableFuture
[WARNING]
C:\Users\ggregory\git\a\mina-sshd\sshd-common\src\main\java\org\apache\sshd\common\future\VerifiableFuture.java:73:
warning - Tag @see: can't find verify(long) in
org.apache.sshd.common.future.VerifiableFuture
[WARNING]
C:\Users\ggregory\git\a\mina-sshd\sshd-common\src\main\java\org\apache\sshd\common\util\threads\ThreadUtils.java:62:
warning - Tag @see:illegal character: "123" in "{@link #isInternal()}"
[WARNING]
C:\Users\ggregory\git\a\mina-sshd\sshd-common\src\main\java\org\apache\sshd\common\util\threads\ThreadUtils.java:62:
warning - Tag @see:illegal character: "64" in "{@link #isInternal()}"
[WARNING]
C:\Users\ggregory\git\a\mina-sshd\sshd-common\src\main\java\org\apache\sshd\common\util\threads\ThreadUtils.java:87:
warning - Tag @see:illegal character: "123" in "{@link #isInternal()}"
[WARNING]
C:\Users\ggregory\git\a\mina-sshd\sshd-common\src\main\java\org\apache\sshd\common\util\threads\ThreadUtils.java:87:
warning - Tag @see:illegal character: "64" in "{@link #isInternal()}"
---
.../sshd/common/future/VerifiableFuture.java | 14 ++++++------
.../apache/sshd/common/future/WaitableFuture.java | 26 +++++++++++-----------
.../sshd/common/util/threads/ThreadUtils.java | 6 ++---
3 files changed, 23 insertions(+), 23 deletions(-)
diff --git
a/sshd-common/src/main/java/org/apache/sshd/common/future/VerifiableFuture.java
b/sshd-common/src/main/java/org/apache/sshd/common/future/VerifiableFuture.java
index 973662aa0..d3f93a47e 100644
---
a/sshd-common/src/main/java/org/apache/sshd/common/future/VerifiableFuture.java
+++
b/sshd-common/src/main/java/org/apache/sshd/common/future/VerifiableFuture.java
@@ -35,11 +35,11 @@ public interface VerifiableFuture<T> {
/**
* Wait {@link Long#MAX_VALUE} msec. and verify that the operation was
successful
*
- * @param options Optional {@link CancelOptions} defining the
behavior on time-out or interrupt; ignored if the
+ * @param options Optional {@link CancelOption}s defining the
behavior on time-out or interrupt; ignored if the
* future is not {@link Cancellable}.
* @return The (same) future instance
* @throws IOException If failed to verify successfully on time
- * @see #verify(long)
+ * @see #verify(long, CancelOption[])
*/
default T verify(CancelOption... options) throws IOException {
return verify(Long.MAX_VALUE, options);
@@ -50,11 +50,11 @@ public interface VerifiableFuture<T> {
*
* @param timeout The number of time units to wait
* @param unit The wait {@link TimeUnit}
- * @param options Optional {@link CancelOptions} defining the
behavior on time-out or interrupt; ignored if the
+ * @param options Optional {@link CancelOption}s defining the
behavior on time-out or interrupt; ignored if the
* future is not {@link Cancellable}.
* @return The (same) future instance
* @throws IOException If failed to verify successfully on time
- * @see #verify(long)
+ * @see #verify(long, CancelOption[])
*/
default T verify(long timeout, TimeUnit unit, CancelOption... options)
throws IOException {
return verify(unit.toMillis(timeout), options);
@@ -64,11 +64,11 @@ public interface VerifiableFuture<T> {
* Wait and verify that the operation was successful
*
* @param timeout The maximum duration to wait, <code>null</code> to
wait forever
- * @param options Optional {@link CancelOptions} defining the
behavior on time-out or interrupt; ignored if the
+ * @param options Optional {@link CancelOption}s defining the
behavior on time-out or interrupt; ignored if the
* future is not {@link Cancellable}.
* @return The (same) future instance
* @throws IOException If failed to verify successfully on time
- * @see #verify(long)
+ * @see #verify(long, CancelOption[])
*/
default T verify(Duration timeout, CancelOption... options) throws
IOException {
return timeout != null ? verify(timeout.toMillis(), options) :
verify(options);
@@ -78,7 +78,7 @@ public interface VerifiableFuture<T> {
* Wait and verify that the operation was successful
*
* @param timeoutMillis Wait timeout in milliseconds
- * @param options Optional {@link CancelOptions} defining the
behavior on time-out or interrupt; ignored if
+ * @param options Optional {@link CancelOption}s defining the
behavior on time-out or interrupt; ignored if
* the future is not {@link Cancellable}.
* @return The (same) future instance
* @throws IOException If failed to verify successfully on time
diff --git
a/sshd-common/src/main/java/org/apache/sshd/common/future/WaitableFuture.java
b/sshd-common/src/main/java/org/apache/sshd/common/future/WaitableFuture.java
index 5dc77c580..594c42b22 100644
---
a/sshd-common/src/main/java/org/apache/sshd/common/future/WaitableFuture.java
+++
b/sshd-common/src/main/java/org/apache/sshd/common/future/WaitableFuture.java
@@ -40,11 +40,11 @@ public interface WaitableFuture {
* Wait {@link Long#MAX_VALUE} msec. for the asynchronous operation to
complete. The attached listeners will be
* notified when the operation is completed.
*
- * @param options Optional {@link CancelOptions} defining the
behavior on time-out or interrupt; ignored if the
+ * @param options Optional {@link CancelOption}s defining the
behavior on time-out or interrupt; ignored if the
* future is not {@link Cancellable}.
* @return {@code true} if the operation is completed.
* @throws IOException if failed - specifically {@link
java.io.InterruptedIOException} if waiting was interrupted
- * @see #await(long)
+ * @see #await(long, CancelOption[])
*/
default boolean await(CancelOption... options) throws IOException {
return await(Long.MAX_VALUE, options);
@@ -55,11 +55,11 @@ public interface WaitableFuture {
*
* @param timeout The number of time units to wait
* @param unit The {@link TimeUnit} for waiting
- * @param options Optional {@link CancelOptions} defining the
behavior on time-out or interrupt; ignored if the
+ * @param options Optional {@link CancelOption}s defining the
behavior on time-out or interrupt; ignored if the
* future is not {@link Cancellable}.
* @return {@code true} if the operation is completed.
* @throws IOException if failed - specifically {@link
java.io.InterruptedIOException} if waiting was interrupted
- * @see #await(long)
+ * @see #await(long, CancelOption[])
*/
default boolean await(long timeout, TimeUnit unit, CancelOption...
options) throws IOException {
return await(unit.toMillis(timeout), options);
@@ -69,11 +69,11 @@ public interface WaitableFuture {
* Wait for the asynchronous operation to complete with the specified
timeout.
*
* @param timeout The maximum duration to wait, <code>null</code> to
wait forever
- * @param options Optional {@link CancelOptions} defining the
behavior on time-out or interrupt; ignored if the
+ * @param options Optional {@link CancelOption}s defining the
behavior on time-out or interrupt; ignored if the
* future is not {@link Cancellable}.
* @return {@code true} if the operation is completed.
* @throws IOException if failed - specifically {@link
java.io.InterruptedIOException} if waiting was interrupted
- * @see #await(long)
+ * @see #await(long, CancelOption[])
*/
default boolean await(Duration timeout, CancelOption... options) throws
IOException {
return timeout != null ? await(timeout.toMillis(), options) :
await(options);
@@ -83,7 +83,7 @@ public interface WaitableFuture {
* Wait for the asynchronous operation to complete with the specified
timeout.
*
* @param timeoutMillis Wait time in milliseconds
- * @param options Optional {@link CancelOptions} defining the
behavior on time-out or interrupt; ignored if
+ * @param options Optional {@link CancelOption}s defining the
behavior on time-out or interrupt; ignored if
* the future is not {@link Cancellable}.
* @return {@code true} if the operation is completed.
* @throws IOException if failed - specifically {@link
java.io.InterruptedIOException} if waiting was interrupted
@@ -94,10 +94,10 @@ public interface WaitableFuture {
* Wait {@link Long#MAX_VALUE} msec. for the asynchronous operation to
complete uninterruptibly. The attached
* listeners will be notified when the operation is completed.
*
- * @param options Optional {@link CancelOptions} defining the behavior on
time-out; ignored if the future is not
+ * @param options Optional {@link CancelOption}s defining the behavior on
time-out; ignored if the future is not
* {@link Cancellable}.
* @return {@code true} if the operation is completed.
- * @see #awaitUninterruptibly(long)
+ * @see #awaitUninterruptibly(long, CancelOption[])
*/
default boolean awaitUninterruptibly(CancelOption... options) {
return awaitUninterruptibly(Long.MAX_VALUE, options);
@@ -108,10 +108,10 @@ public interface WaitableFuture {
*
* @param timeout The number of time units to wait
* @param unit The {@link TimeUnit} for waiting
- * @param options Optional {@link CancelOptions} defining the behavior on
time-out; ignored if the future is not
+ * @param options Optional {@link CancelOption}s defining the behavior on
time-out; ignored if the future is not
* {@link Cancellable}.
* @return {@code true} if the operation is completed.
- * @see #awaitUninterruptibly(long)
+ * @see #awaitUninterruptibly(long, CancelOption[])
*/
default boolean awaitUninterruptibly(long timeout, TimeUnit unit,
CancelOption... options) {
return awaitUninterruptibly(unit.toMillis(timeout), options);
@@ -121,7 +121,7 @@ public interface WaitableFuture {
* Wait for the asynchronous operation to complete with the specified
timeout uninterruptibly.
*
* @param timeoutMillis Wait time, <code>null</code> to wait forever
- * @param options Optional {@link CancelOptions} defining the
behavior on time-out; ignored if the future is
+ * @param options Optional {@link CancelOption}s defining the
behavior on time-out; ignored if the future is
* not {@link Cancellable}.
* @return {@code true} if the operation is finished.
*/
@@ -133,7 +133,7 @@ public interface WaitableFuture {
* Wait for the asynchronous operation to complete with the specified
timeout uninterruptibly.
*
* @param timeoutMillis Wait time in milliseconds
- * @param options Optional {@link CancelOptions} defining the
behavior on time-out; ignored if the future is
+ * @param options Optional {@link CancelOption}s defining the
behavior on time-out; ignored if the future is
* not {@link Cancellable}.
* @return {@code true} if the operation is finished.
*/
diff --git
a/sshd-common/src/main/java/org/apache/sshd/common/util/threads/ThreadUtils.java
b/sshd-common/src/main/java/org/apache/sshd/common/util/threads/ThreadUtils.java
index 9f2b3be73..a94ff9cce 100644
---
a/sshd-common/src/main/java/org/apache/sshd/common/util/threads/ThreadUtils.java
+++
b/sshd-common/src/main/java/org/apache/sshd/common/util/threads/ThreadUtils.java
@@ -57,7 +57,7 @@ public final class ThreadUtils {
* @param code code to run
* @return the result of {@code code}
* @throws Exception propagated from {@code code.call()}
- * @see {@link #isInternal()}
+ * @see #isInternalThread()
*/
public static <V> V runAsInternal(Callable<V> code) throws Exception {
if (isInternalThread()) {
@@ -81,8 +81,8 @@ public final class ThreadUtils {
* @param param parameter for the function
* @param code function to run
* @return the result of {@code code}
- * @throws Exception propagated from {@code code.apply()}
- * @see {@link #isInternal()}
+ * @throws IOException propagated from {@code code.apply()}
+ * @see #isInternalThread()
*/
public static <T, V> V runAsInternal(T param, IOFunction<? super T, V>
code) throws IOException {
if (isInternalThread()) {
