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/12/05 21:04:41 UTC
[2/2] mina git commit: Fixed some missing Javadoc
Fixed 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/09b33752
Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/09b33752
Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/09b33752
Branch: refs/heads/2.0
Commit: 09b33752184951d4fd0c49e9ba8779eca808abd9
Parents: 4eb0a0c
Author: Emmanuel L�charny <el...@symas.com>
Authored: Mon Dec 5 22:04:22 2016 +0100
Committer: Emmanuel L�charny <el...@symas.com>
Committed: Mon Dec 5 22:04:22 2016 +0100
----------------------------------------------------------------------
.../context/AbstractStateContextLookup.java | 6 +++---
.../transport/socket/apr/AprDatagramSession.java | 2 --
.../mina/transport/socket/apr/AprLibrary.java | 2 +-
.../mina/transport/socket/apr/AprSession.java | 16 ++++++++--------
.../mina/transport/socket/apr/AprSocketSession.java | 2 --
5 files changed, 12 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mina/blob/09b33752/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/AbstractStateContextLookup.java
----------------------------------------------------------------------
diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/AbstractStateContextLookup.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/AbstractStateContextLookup.java
index 12d555e..cebfd18 100644
--- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/AbstractStateContextLookup.java
+++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/AbstractStateContextLookup.java
@@ -21,12 +21,12 @@ package org.apache.mina.statemachine.context;
/**
* Abstract {@link StateContextLookup} implementation. The {@link #lookup(Object[])}
- * method will loop through the event arguments and call the {@link #supports(Class)}
+ * method will loop through the event arguments and call the supports(Class)
* method for each of them. The first argument that this method returns
- * <tt>true</tt> for will be passed to the abstract {@link #lookup(Object)}
+ * <tt>true</tt> for will be passed to the abstract lookup(Object)
* method which should try to extract a {@link StateContext} from the argument.
* If none is found a new {@link StateContext} will be created and stored in the
- * event argument using the {@link #store(Object, StateContext)} method.
+ * event argument using the store(Object, StateContext) method.
*
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
http://git-wip-us.apache.org/repos/asf/mina/blob/09b33752/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprDatagramSession.java
----------------------------------------------------------------------
diff --git a/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprDatagramSession.java b/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprDatagramSession.java
index 4e07194..50108ee 100644
--- a/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprDatagramSession.java
+++ b/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprDatagramSession.java
@@ -45,8 +45,6 @@ class AprDatagramSession extends AprSession {
/**
* Create an instance of {@link AprDatagramSession}.
- *
- * {@inheritDoc}
*/
AprDatagramSession(IoService service, IoProcessor<AprSession> processor, long descriptor,
InetSocketAddress remoteAddress) throws Exception {
http://git-wip-us.apache.org/repos/asf/mina/blob/09b33752/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprLibrary.java
----------------------------------------------------------------------
diff --git a/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprLibrary.java b/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprLibrary.java
index cbcfd51..8df91ed 100644
--- a/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprLibrary.java
+++ b/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprLibrary.java
@@ -29,7 +29,7 @@ import org.apache.tomcat.jni.Pool;
* It'll finalize nicely the native resources (libraries and memory pools).
*
* Each memory pool used in the APR transport module needs to be children of the
- * root pool {@link AprLibrary#getRootPool()}.
+ * root pool AprLibrary#getRootPool().
*
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
http://git-wip-us.apache.org/repos/asf/mina/blob/09b33752/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSession.java
----------------------------------------------------------------------
diff --git a/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSession.java b/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSession.java
index 2045641..8b676e7 100644
--- a/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSession.java
+++ b/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSession.java
@@ -65,7 +65,7 @@ public abstract class AprSession extends AbstractIoSession {
* @param service the {@link IoService} creating this session. Can be {@link AprSocketAcceptor} or
* {@link AprSocketConnector}
* @param processor the {@link AprIoProcessor} managing this session.
- * @param descriptor the low level APR socket descriptor for this socket. {@see Socket#create(int, int, int, long)}
+ * @param descriptor the low level APR socket descriptor for this socket. @see Socket#create(int, int, int, long)
* @throws Exception exception produced during the setting of all the socket parameters.
*/
AprSession(IoService service, IoProcessor<AprSession> processor, long descriptor) throws Exception {
@@ -86,7 +86,7 @@ public abstract class AprSession extends AbstractIoSession {
* @param service the {@link IoService} creating this session. Can be {@link AprSocketAcceptor} or
* {@link AprSocketConnector}
* @param processor the {@link AprIoProcessor} managing this session.
- * @param descriptor the low level APR socket descriptor for this socket. {@see Socket#create(int, int, int, long)}
+ * @param descriptor the low level APR socket descriptor for this socket. @see Socket#create(int, int, int, long)
* @param remoteAddress the remote end-point
* @throws Exception exception produced during the setting of all the socket parameters.
*/
@@ -103,7 +103,7 @@ public abstract class AprSession extends AbstractIoSession {
}
/**
- * Get the socket descriptor {@see Socket#create(int, int, int, long)}.
+ * Get the socket descriptor @see Socket#create(int, int, int, long).
* @return the low level APR socket descriptor
*/
long getDescriptor() {
@@ -112,7 +112,7 @@ public abstract class AprSession extends AbstractIoSession {
/**
* Set the socket descriptor.
- * @param desc the low level APR socket descriptor created by {@see Socket#create(int, int, int, long)}
+ * @param desc the low level APR socket descriptor created by @see Socket#create(int, int, int, long)
*/
void setDescriptor(long desc) {
this.descriptor = desc;
@@ -189,7 +189,7 @@ public abstract class AprSession extends AbstractIoSession {
/**
* Does this session needs to be registered for read events.
- * Used for building poll set {@see Poll}.
+ * Used for building poll set @see Poll.
* @return true if registered
*/
boolean isInterestedInRead() {
@@ -198,7 +198,7 @@ public abstract class AprSession extends AbstractIoSession {
/**
* Set if this session needs to be registered for read events.
- * Used for building poll set {@see Poll}.
+ * Used for building poll set @see Poll.
* @param isOpRead true if need to be registered
*/
void setInterestedInRead(boolean isOpRead) {
@@ -207,7 +207,7 @@ public abstract class AprSession extends AbstractIoSession {
/**
* Does this session needs to be registered for write events.
- * Used for building poll set {@see Poll}.
+ * Used for building poll set @see Poll.
* @return true if registered
*/
boolean isInterestedInWrite() {
@@ -216,7 +216,7 @@ public abstract class AprSession extends AbstractIoSession {
/**
* Set if this session needs to be registered for write events.
- * Used for building poll set {@see Poll}.
+ * Used for building poll set @see Poll.
* @param isOpWrite true if need to be registered
*/
void setInterestedInWrite(boolean isOpWrite) {
http://git-wip-us.apache.org/repos/asf/mina/blob/09b33752/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSocketSession.java
----------------------------------------------------------------------
diff --git a/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSocketSession.java b/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSocketSession.java
index 3d5b210..3c56b96 100644
--- a/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSocketSession.java
+++ b/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSocketSession.java
@@ -45,8 +45,6 @@ class AprSocketSession extends AprSession {
/**
* Create an instance of {@link AprSocketSession}.
- *
- * {@inheritDoc}
*/
AprSocketSession(IoService service, IoProcessor<AprSession> processor, long descriptor) throws Exception {
super(service, processor, descriptor);