Repository: mina Updated Branches: refs/heads/2.0 6f571c1ea -> f1972fc3d
Added some missing JavaDoc Project: http://git-wip-us.apache.org/repos/asf/mina/repo Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/aff52b8f Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/aff52b8f Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/aff52b8f Branch: refs/heads/2.0 Commit: aff52b8fef99d3775c03421c3f721e1a3a3a66f9 Parents: 6f571c1 Author: Emmanuel Lécharny <[email protected]> Authored: Tue Nov 4 11:37:28 2014 +0100 Committer: Emmanuel Lécharny <[email protected]> Committed: Tue Nov 4 11:37:28 2014 +0100 ---------------------------------------------------------------------- .../src/main/java/org/apache/mina/core/future/IoFuture.java | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mina/blob/aff52b8f/mina-core/src/main/java/org/apache/mina/core/future/IoFuture.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/future/IoFuture.java b/mina-core/src/main/java/org/apache/mina/core/future/IoFuture.java index 519f85a..db740b0 100644 --- a/mina-core/src/main/java/org/apache/mina/core/future/IoFuture.java +++ b/mina-core/src/main/java/org/apache/mina/core/future/IoFuture.java @@ -32,7 +32,7 @@ import org.apache.mina.core.session.IoSession; */ public interface IoFuture { /** - * Returns the {@link IoSession} which is associated with this future. + * @return the {@link IoSession} which is associated with this future. */ IoSession getSession(); @@ -40,6 +40,9 @@ public interface IoFuture { * Wait for the asynchronous operation to complete. * The attached listeners will be notified when the operation is * completed. + * + * @return The instance of IoFuture that we are waiting for + * @exception InterruptedException If the thread is interrupted while waiting */ IoFuture await() throws InterruptedException; @@ -49,7 +52,7 @@ public interface IoFuture { * @param timeout The maximum delay to wait before getting out * @param unit the type of unit for the delay (seconds, minutes...) * @return <tt>true</tt> if the operation is completed. - * @exception InterruptedException If the thread is interruped while waiting + * @exception InterruptedException If the thread is interrupted while waiting */ boolean await(long timeout, TimeUnit unit) throws InterruptedException; @@ -58,7 +61,7 @@ public interface IoFuture { * * @param timeout The maximum milliseconds to wait before getting out * @return <tt>true</tt> if the operation is completed. - * @exception InterruptedException If the thread is interruped while waiting + * @exception InterruptedException If the thread is interrupted while waiting */ boolean await(long timeoutMillis) throws InterruptedException;
