You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by el...@apache.org on 2016/08/25 06:06:40 UTC
mina git commit: Fixed some Javadoc errors
Repository: mina
Updated Branches:
refs/heads/2.0 ce39e834e -> 009bfa202
Fixed some Javadoc errors
Project: http://git-wip-us.apache.org/repos/asf/mina/repo
Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/009bfa20
Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/009bfa20
Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/009bfa20
Branch: refs/heads/2.0
Commit: 009bfa202601b601a30ebea19f49714de330bfd3
Parents: ce39e83
Author: Emmanuel L�charny <el...@symas.com>
Authored: Thu Aug 25 08:06:15 2016 +0200
Committer: Emmanuel L�charny <el...@symas.com>
Committed: Thu Aug 25 08:06:15 2016 +0200
----------------------------------------------------------------------
.../org/apache/mina/core/polling/AbstractPollingIoProcessor.java | 2 +-
.../main/java/org/apache/mina/core/session/AbstractIoSession.java | 3 +--
.../src/main/java/org/apache/mina/core/session/IoSession.java | 2 ++
.../org/apache/mina/filter/codec/CumulativeProtocolDecoder.java | 2 +-
.../main/java/org/apache/mina/example/tcp/perf/TcpSslServer.java | 2 +-
5 files changed, 6 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mina/blob/009bfa20/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java b/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java
index c1295f6..853b8a3 100644
--- a/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java
+++ b/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java
@@ -343,7 +343,7 @@ public abstract class AbstractPollingIoProcessor<S extends AbstractIoSession> im
* @param length the number of bytes to write can be superior to the number of
* bytes remaining in the buffer
* @return the number of byte written
- * @throws Exception any exception thrown by the underlying system calls
+ * @throws IOException any exception thrown by the underlying system calls
*/
protected abstract int write(S session, IoBuffer buf, int length) throws IOException;
http://git-wip-us.apache.org/repos/asf/mina/blob/009bfa20/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSession.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSession.java b/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSession.java
index 842859f..63d975d 100644
--- a/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSession.java
+++ b/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSession.java
@@ -361,9 +361,8 @@ public abstract class AbstractIoSession implements IoSession {
/**
* Destroy the session
- *
*/
- protected void destroy() throws Exception {
+ protected void destroy() {
if (writeRequestQueue != null) {
while (!writeRequestQueue.isEmpty(this)) {
WriteRequest writeRequest = writeRequestQueue.poll(this);
http://git-wip-us.apache.org/repos/asf/mina/blob/009bfa20/mina-core/src/main/java/org/apache/mina/core/session/IoSession.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/core/session/IoSession.java b/mina-core/src/main/java/org/apache/mina/core/session/IoSession.java
index 2e712ee..3a7bc73 100644
--- a/mina-core/src/main/java/org/apache/mina/core/session/IoSession.java
+++ b/mina-core/src/main/java/org/apache/mina/core/session/IoSession.java
@@ -185,6 +185,8 @@ public interface IoSession {
/**
* Closes this session immediately. This operation is asynchronous, it
* returns a {@link CloseFuture}.
+ *
+ * @return The {@link CloseFuture} that can be use to wait for the completion of this operation
*/
CloseFuture closeNow();
http://git-wip-us.apache.org/repos/asf/mina/blob/009bfa20/mina-core/src/main/java/org/apache/mina/filter/codec/CumulativeProtocolDecoder.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/CumulativeProtocolDecoder.java b/mina-core/src/main/java/org/apache/mina/filter/codec/CumulativeProtocolDecoder.java
index ebeae0d..43e4437 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/codec/CumulativeProtocolDecoder.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/codec/CumulativeProtocolDecoder.java
@@ -251,7 +251,7 @@ public abstract class CumulativeProtocolDecoder extends ProtocolDecoderAdapter {
* Let the user change the way we handle fragmentation. If set to <tt>false</tt>, the
* decode() method will not check the TransportMetadata fragmentation capability
*
- * @param handleFragment The flag to set.
+ * @param transportMetadataFragmentation The flag to set.
*/
public void setTransportMetadataFragmentation(boolean transportMetadataFragmentation) {
this.transportMetadataFragmentation = transportMetadataFragmentation;
http://git-wip-us.apache.org/repos/asf/mina/blob/009bfa20/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpSslServer.java
----------------------------------------------------------------------
diff --git a/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpSslServer.java b/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpSslServer.java
index 63b1680..13aaf07 100644
--- a/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpSslServer.java
+++ b/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpSslServer.java
@@ -129,7 +129,7 @@ public class TcpSslServer extends IoHandlerAdapter {
* Create the TCP server
*
* @throws IOException If something went wrong
- * @throws GeneralSecurityException
+ * @throws GeneralSecurityException If something went wrong
*/
public TcpSslServer() throws IOException, GeneralSecurityException {
NioSocketAcceptor acceptor = new NioSocketAcceptor();