This is an automated email from the ASF dual-hosted git repository.
elecharny pushed a commit to branch 2.0.X
in repository https://gitbox.apache.org/repos/asf/mina.git
The following commit(s) were added to refs/heads/2.0.X by this push:
new 808354534 Fixed some javadoc issues
808354534 is described below
commit 808354534741ba2e57f84b11997677b7447744b3
Author: emmanuel lecharny <elecha...@apache.org>
AuthorDate: Wed Sep 6 15:46:06 2023 +0200
Fixed some javadoc issues
---
.../src/main/java/org/apache/mina/core/.IoUtil.java.swp | Bin 0 -> 20480 bytes
.../src/main/java/org/apache/mina/core/IoUtil.java | 8 ++++----
.../org/apache/mina/core/buffer/AbstractIoBuffer.java | 4 ++--
.../main/java/org/apache/mina/core/buffer/IoBuffer.java | 12 ++++++------
.../org/apache/mina/core/filterchain/IoFilterChain.java | 2 +-
.../mina/core/polling/AbstractPollingIoConnector.java | 2 +-
.../mina/core/polling/AbstractPollingIoProcessor.java | 8 ++++----
.../java/org/apache/mina/core/service/IoAcceptor.java | 2 +-
.../java/org/apache/mina/core/service/IoService.java | 2 +-
.../java/org/apache/mina/core/session/DummySession.java | 2 +-
.../java/org/apache/mina/core/session/IoSession.java | 8 ++++----
.../apache/mina/core/session/IoSessionAttributeMap.java | 4 ++--
.../org/apache/mina/core/session/IoSessionConfig.java | 2 +-
.../mina/filter/codec/CumulativeProtocolDecoder.java | 4 ++--
.../org/apache/mina/filter/executor/ExecutorFilter.java | 4 ++--
.../mina/filter/executor/IoEventQueueHandler.java | 2 +-
.../apache/mina/filter/keepalive/KeepAliveFilter.java | 4 ++--
.../org/apache/mina/filter/ssl/SslContextFactory.java | 4 ++--
.../main/java/org/apache/mina/filter/ssl/SslFilter.java | 10 +++++-----
.../java/org/apache/mina/filter/ssl/SslHandler.java | 2 +-
.../apache/mina/handler/demux/DemuxingIoHandler.java | 6 +++---
.../org/apache/mina/handler/demux/MessageHandler.java | 2 +-
.../transport/socket/AbstractDatagramSessionConfig.java | 10 +++++-----
.../transport/socket/AbstractSocketSessionConfig.java | 16 ++++++++--------
.../apache/mina/transport/socket/SocketAcceptor.java | 2 +-
.../mina/transport/socket/SocketSessionConfig.java | 10 +++++-----
.../util/byteaccess/CompositeByteArrayRelativeBase.java | 2 +-
.../java/org/apache/mina/filter/compression/Zlib.java | 8 ++++----
.../context/AbstractStateContextLookup.java | 2 +-
.../mina/statemachine/transition/SelfTransition.java | 2 +-
30 files changed, 73 insertions(+), 73 deletions(-)
diff --git a/mina-core/src/main/java/org/apache/mina/core/.IoUtil.java.swp
b/mina-core/src/main/java/org/apache/mina/core/.IoUtil.java.swp
new file mode 100644
index 000000000..0806e0c2b
Binary files /dev/null and
b/mina-core/src/main/java/org/apache/mina/core/.IoUtil.java.swp differ
diff --git a/mina-core/src/main/java/org/apache/mina/core/IoUtil.java
b/mina-core/src/main/java/org/apache/mina/core/IoUtil.java
index 72510e4d9..533ac3b1a 100644
--- a/mina-core/src/main/java/org/apache/mina/core/IoUtil.java
+++ b/mina-core/src/main/java/org/apache/mina/core/IoUtil.java
@@ -158,7 +158,7 @@ public final class IoUtil {
* @param futures The {@link IoFuture}s we are waiting on
* @param timeout The maximum time we wait for the {@link IoFuture}s to
complete
* @param unit The Time unit to use for the timeout
- * @return {@code TRUE</TT> if all the {@link IoFuture} have been
completed, <tt>FALSE} if
+ * @return {@code TRUE} if all the {@link IoFuture} have been completed,
{@code FALSE} if
* at least one {@link IoFuture} haas been interrupted
* @throws InterruptedException If one of the {@link IoFuture} is
interrupted
*/
@@ -172,7 +172,7 @@ public final class IoUtil {
*
* @param futures The {@link IoFuture}s we are waiting on
* @param timeoutMillis The maximum milliseconds we wait for the {@link
IoFuture}s to complete
- * @return {@code TRUE</TT> if all the {@link IoFuture} have been
completed, <tt>FALSE} if
+ * @return {@code TRUE} if all the {@link IoFuture} have been completed,
{@code FALSE} if
* at least one {@link IoFuture} has been interrupted
* @throws InterruptedException If one of the {@link IoFuture} is
interrupted
*/
@@ -186,7 +186,7 @@ public final class IoUtil {
* @param futures The {@link IoFuture}s we are waiting on
* @param timeout The maximum time we wait for the {@link IoFuture}s to
complete
* @param unit The Time unit to use for the timeout
- * @return {@code TRUE</TT> if all the {@link IoFuture} have been
completed, <tt>FALSE} if
+ * @return {@code TRUE} if all the {@link IoFuture} have been completed,
{@code FALSE} if
* at least one {@link IoFuture} has been interrupted
*/
public static boolean awaitUninterruptibly(Iterable<? extends IoFuture>
futures, long timeout, TimeUnit unit) {
@@ -198,7 +198,7 @@ public final class IoUtil {
*
* @param futures The {@link IoFuture}s we are waiting on
* @param timeoutMillis The maximum milliseconds we wait for the {@link
IoFuture}s to complete
- * @return {@code TRUE</TT> if all the {@link IoFuture} have been
completed, <tt>FALSE} if
+ * @return {@code TRUE} if all the {@link IoFuture} have been completed,
{@code FALSE} if
* at least one {@link IoFuture} has been interrupted
*/
public static boolean awaitUninterruptibly(Iterable<? extends IoFuture>
futures, long timeoutMillis) {
diff --git
a/mina-core/src/main/java/org/apache/mina/core/buffer/AbstractIoBuffer.java
b/mina-core/src/main/java/org/apache/mina/core/buffer/AbstractIoBuffer.java
index 523a117ac..c281922e2 100644
--- a/mina-core/src/main/java/org/apache/mina/core/buffer/AbstractIoBuffer.java
+++ b/mina-core/src/main/java/org/apache/mina/core/buffer/AbstractIoBuffer.java
@@ -2727,7 +2727,7 @@ public abstract class AbstractIoBuffer extends IoBuffer {
/**
* This method forwards the call to {@link #expand(int)} only when
- * {@code autoExpand</tt> property is <tt>true}.
+ * {@code autoExpand} property is {@code true}.
*/
private IoBuffer autoExpand(int expectedRemaining) {
if (isAutoExpand()) {
@@ -2738,7 +2738,7 @@ public abstract class AbstractIoBuffer extends IoBuffer {
/**
* This method forwards the call to {@link #expand(int)} only when
- * {@code autoExpand</tt> property is <tt>true}.
+ * {@code autoExpand} property is {@code true}.
*/
private IoBuffer autoExpand(int pos, int expectedRemaining) {
if (isAutoExpand()) {
diff --git a/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java
b/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java
index cca2635fa..b2cc61905 100644
--- a/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java
+++ b/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java
@@ -84,7 +84,7 @@ import org.apache.mina.core.session.IoSession;
* <p>
* Writing variable-length data using NIO {@code ByteBuffers} is not really
* easy, and it is because its size is fixed at allocation. {@link IoBuffer}
introduces
- * the {@code autoExpand</tt> property. If <tt>autoExpand} property is set
to true,
+ * the {@code autoExpand} property. If {@codeautoExpand} property is set to
true,
* you never get a {@link BufferOverflowException} or
* an {@link IndexOutOfBoundsException} (except when index is negative). It
* automatically expands its capacity. For instance:
@@ -221,7 +221,7 @@ public abstract class IoBuffer implements
Comparable<IoBuffer> {
* Returns a direct or heap IoBuffer which can contain the specified
number of bytes.
*
* @param capacity the capacity of the buffer
- * @param useDirectBuffer {@code true</tt> to get a direct buffer,
<tt>false} to get a
+ * @param useDirectBuffer {@code true} to get a direct buffer, {@code
false} to get a
* heap buffer.
* @return a direct or heap IoBuffer which can hold up to capacity bytes
*/
@@ -403,7 +403,7 @@ public abstract class IoBuffer implements
Comparable<IoBuffer> {
public abstract IoBuffer capacity(int newCapacity);
/**
- * @return {@code true</tt> if and only if <tt>autoExpand} is turned on.
+ * @return {@code true} if and only if {@code sautoExpand} is turned on.
*/
public abstract boolean isAutoExpand();
@@ -416,7 +416,7 @@ public abstract class IoBuffer implements
Comparable<IoBuffer> {
public abstract IoBuffer setAutoExpand(boolean autoExpand);
/**
- * @return {@code true</tt> if and only if <tt>autoShrink} is turned on.
+ * @return {@code true} if and only if {@code autoShrink} is turned on.
*/
public abstract boolean isAutoShrink();
@@ -431,7 +431,7 @@ public abstract class IoBuffer implements
Comparable<IoBuffer> {
/**
* Changes the capacity and limit of this buffer so this buffer get the
* specified {@code expectedRemaining} room from the current position. This
- * method works even if you didn't set {@code autoExpand</tt> to <tt>true}.
+ * method works even if you didn't set {@code autoExpand} to {@code true}.
* <br>
* Assuming a buffer contains N bytes, its position is P and its current
capacity is C,
* here are the resulting buffer if we call the expand method with a
expectedRemaining
@@ -501,7 +501,7 @@ public abstract class IoBuffer implements
Comparable<IoBuffer> {
* Changes the capacity and limit of this buffer so this buffer get the
* specified {@code expectedRemaining} room from the specified
* {@code position}. This method works even if you didn't set
- * {@code autoExpand</tt> to <tt>true}.
+ * {@code autoExpand} to {@code true}.
* Assuming a buffer contains N bytes, its position is P and its current
capacity is C,
* here are the resulting buffer if we call the expand method with a
expectedRemaining
* value V :
diff --git
a/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterChain.java
b/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterChain.java
index 22d0cbb62..e1b2e4cad 100644
---
a/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterChain.java
+++
b/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterChain.java
@@ -133,7 +133,7 @@ public interface IoFilterChain {
/**
* @param filter The filter we are looking for
*
- * @return {@code true</tt> if this chain contains the specified
<tt>filter}.
+ * @return {@code true} if this chain contains the specified {@code
filter}.
*/
boolean contains(IoFilter filter);
diff --git
a/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoConnector.java
b/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoConnector.java
index ecf7639de..dcaca9e3d 100644
---
a/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoConnector.java
+++
b/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoConnector.java
@@ -248,7 +248,7 @@ public abstract class AbstractPollingIoConnector<S extends
AbstractIoSession, H>
*
* @param handle the client socket handle
* @param remoteAddress the remote address where to connect
- * @return {@code true</tt> if a connection was established, <tt>false} if
+ * @return {@code true} if a connection was established, {@code false} if
* this client socket is in non-blocking mode and the connection
* operation is in progress
* @throws Exception If the connect failed
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 263f09039..695be5fe7 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
@@ -270,7 +270,7 @@ public abstract class AbstractPollingIoProcessor<S extends
AbstractIoSession> im
*
* @param session
* the queried session
- * @return {@code true</tt> is ready, <tt>false} if not ready
+ * @return {@code true} is ready, {@code false} if not ready
*/
protected abstract boolean isWritable(S session);
@@ -279,7 +279,7 @@ public abstract class AbstractPollingIoProcessor<S extends
AbstractIoSession> im
*
* @param session
* the queried session
- * @return {@code true</tt> is ready, <tt>false} if not ready
+ * @return {@code true} is ready, {@code false} if not ready
*/
protected abstract boolean isReadable(S session);
@@ -289,7 +289,7 @@ public abstract class AbstractPollingIoProcessor<S extends
AbstractIoSession> im
* @param session
* the session for which we want to be interested in write
events
* @param isInterested
- * {@code true</tt> for registering, <tt>false} for removing
+ * {@code true} for registering, {@code false} for removing
* @throws Exception
* If there was a problem while registering the session
*/
@@ -301,7 +301,7 @@ public abstract class AbstractPollingIoProcessor<S extends
AbstractIoSession> im
* @param session
* the session for which we want to be interested in read events
* @param isInterested
- * {@code true</tt> for registering, <tt>false} for removing
+ * {@code true} for registering, {@code false} for removing
* @throws Exception
* If there was a problem while registering the session
*/
diff --git
a/mina-core/src/main/java/org/apache/mina/core/service/IoAcceptor.java
b/mina-core/src/main/java/org/apache/mina/core/service/IoAcceptor.java
index 9ce62102c..5357b2b32 100644
--- a/mina-core/src/main/java/org/apache/mina/core/service/IoAcceptor.java
+++ b/mina-core/src/main/java/org/apache/mina/core/service/IoAcceptor.java
@@ -227,7 +227,7 @@ public interface IoAcceptor extends IoService {
/**
* (Optional) Returns an {@link IoSession} that is bound to the specified
- * {@code localAddress</tt> and the specified <tt>remoteAddress} which
+ * {@code localAddress} and the specified {@code remoteAddress} which
* reuses the local address that is already bound by this service.
* <p>
* This operation is optional. Please throw {@link
UnsupportedOperationException}
diff --git
a/mina-core/src/main/java/org/apache/mina/core/service/IoService.java
b/mina-core/src/main/java/org/apache/mina/core/service/IoService.java
index 4c2f39bf2..454b2457b 100644
--- a/mina-core/src/main/java/org/apache/mina/core/service/IoService.java
+++ b/mina-core/src/main/java/org/apache/mina/core/service/IoService.java
@@ -141,7 +141,7 @@ public interface IoService {
void setFilterChainBuilder(IoFilterChainBuilder builder);
/**
- * A shortcut for {@code ( ( DefaultIoFilterChainBuilder ) </tt>{@link
#getFilterChainBuilder()}<tt> )}.
+ * A shortcut for {@code ( ( DefaultIoFilterChainBuilder )} {@link
#getFilterChainBuilder()}.
* Please note that the returned object is not a <b>real</b> {@link
IoFilterChain}
* but a {@link DefaultIoFilterChainBuilder}. Modifying the returned
builder
* won't affect the existing {@link IoSession}s at all, because
diff --git
a/mina-core/src/main/java/org/apache/mina/core/session/DummySession.java
b/mina-core/src/main/java/org/apache/mina/core/session/DummySession.java
index e5bb3da33..ce442a980 100644
--- a/mina-core/src/main/java/org/apache/mina/core/session/DummySession.java
+++ b/mina-core/src/main/java/org/apache/mina/core/session/DummySession.java
@@ -412,7 +412,7 @@ public class DummySession extends AbstractIoSession {
* this method returns silently without updating the throughput properties
* if they were calculated already within last
* {@link IoSessionConfig#getThroughputCalculationInterval() calculation
interval}.
- * If, however, {@code force</tt> is specified as <tt>true}, this method
+ * If, however, {@code force} is specified as {@code true}, this method
* updates the throughput properties immediately.
*
* @param force the flag that forces the update of properties immediately
if {@code true}
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 0ba694d00..b1fd6ff4b 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
@@ -146,7 +146,7 @@ public interface IoSession {
WriteFuture write(Object message);
/**
- * (Optional) Writes the specified {@code message</tt> to the specified
<tt>destination}.
+ * (Optional) Writes the specified {@code message} to the specified {@code
destination}.
* This operation is asynchronous; {@link IoHandler#messageSent(IoSession,
Object)}
* will be invoked when the message is actually sent to remote peer. You
can
* also wait for the returned {@link WriteFuture} if you want to wait for
@@ -481,7 +481,7 @@ public interface IoSession {
* silently without updating the throughput properties if they were
* calculated already within last
* {@link IoSessionConfig#getThroughputCalculationInterval() calculation
interval}.
- * If, however, {@code force</tt> is specified as <tt>true}, this method
+ * If, however, {@code force} is specified as {@code true}, this method
* updates the throughput properties immediately.
* @param currentTime the current time in milliseconds
@@ -605,9 +605,9 @@ public interface IoSession {
* for the specified {@link IdleStatus}.
* <p>
* If {@code sessionIdle} event is fired first after some time after I/O,
- * {@code idleCount</tt> becomes <tt>1</tt>. <tt>idleCount} resets to
+ * {@code idleCount} becomes {@code 1}. {@code idleCount} resets to
* {@code 0} if any I/O occurs again, otherwise it increases to
- * {@code 2</tt> and so on if <tt>sessionIdle} event is fired again without
+ * {@code 2} and so on if {@code sessionIdle} event is fired again without
* any I/O between two (or more) {@code sessionIdle} events.
*/
int getIdleCount(IdleStatus status);
diff --git
a/mina-core/src/main/java/org/apache/mina/core/session/IoSessionAttributeMap.java
b/mina-core/src/main/java/org/apache/mina/core/session/IoSessionAttributeMap.java
index af3e9a6b8..78397861c 100644
---
a/mina-core/src/main/java/org/apache/mina/core/session/IoSessionAttributeMap.java
+++
b/mina-core/src/main/java/org/apache/mina/core/session/IoSessionAttributeMap.java
@@ -105,7 +105,7 @@ public interface IoSessionAttributeMap {
* @param session the session for which we want to remove a value
* @param key The key we are looking for
* @param value The value to remove
- * @return {@code true</tt> if the value has been removed, <tt>false} if
the key was
+ * @return {@code true} if the value has been removed, {@code false} if
the key was
* not found of the value not removed
*/
boolean removeAttribute(IoSession session, Object key, Object value);
@@ -128,7 +128,7 @@ public interface IoSessionAttributeMap {
* @param key The key we are looking for
* @param oldValue The old value to replace
* @param newValue The new value to set
- * @return {@code true</tt> if the value has been replaced, <tt>false} if
the key was
+ * @return {@code true} if the value has been replaced, {@code false} if
the key was
* not found of the value not replaced
*/
boolean replaceAttribute(IoSession session, Object key, Object oldValue,
Object newValue);
diff --git
a/mina-core/src/main/java/org/apache/mina/core/session/IoSessionConfig.java
b/mina-core/src/main/java/org/apache/mina/core/session/IoSessionConfig.java
index 324961f1a..d85ca2803 100644
--- a/mina-core/src/main/java/org/apache/mina/core/session/IoSessionConfig.java
+++ b/mina-core/src/main/java/org/apache/mina/core/session/IoSessionConfig.java
@@ -206,7 +206,7 @@ public interface IoSessionConfig {
* and can cause unintended memory leak, and therefore it's disabled by
* default.
*
- * @param useReadOperation {@code true</tt> if the read operation is
enabled, <tt>false} otherwise
+ * @param useReadOperation {@code true} if the read operation is enabled,
{@code false} otherwise
*/
void setUseReadOperation(boolean useReadOperation);
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 5281d067f..7255d6638 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
@@ -118,11 +118,11 @@ public abstract class CumulativeProtocolDecoder extends
ProtocolDecoderAdapter {
* Cumulates content of {@code in} into internal buffer and forwards
* decoding request to
* doDecode(IoSession, IoBuffer, ProtocolDecoderOutput).
- * {@code doDecode()</tt> is invoked repeatedly until it returns <tt>false}
+ * {@code doDecode() is invoked repeatedly until it returns {@code false}
* and the cumulative buffer is compacted after decoding ends.
*
* @throws IllegalStateException
- * if your {@code doDecode()</tt> returned <tt>true} not
+ * if your {@code doDecode()} returned {@code true} not
* consuming the cumulative buffer.
*/
@Override
diff --git
a/mina-core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java
b/mina-core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java
index 59122bb59..b5b6db60e 100644
---
a/mina-core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java
+++
b/mina-core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java
@@ -80,8 +80,8 @@ import org.apache.mina.core.write.WriteRequest;
*
* <h2>Selective Filtering</h2>
*
- * By default, all event types but {@code sessionCreated</tt>,
<tt>filterWrite},
- * {@code filterClose</tt> and <tt>filterSetTrafficMask} are submitted to the
+ * By default, all event types but {@code sessionCreated}, {@code filterWrite},
+ * {@code filterClose} and {@code filterSetTrafficMask} are submitted to the
* underlying executor, which is most common setting.
* <p>
* If you want to submit only a certain set of event types, you can specify
them
diff --git
a/mina-core/src/main/java/org/apache/mina/filter/executor/IoEventQueueHandler.java
b/mina-core/src/main/java/org/apache/mina/filter/executor/IoEventQueueHandler.java
index 59be99189..8930b00ba 100644
---
a/mina-core/src/main/java/org/apache/mina/filter/executor/IoEventQueueHandler.java
+++
b/mina-core/src/main/java/org/apache/mina/filter/executor/IoEventQueueHandler.java
@@ -61,7 +61,7 @@ public interface IoEventQueueHandler extends EventListener {
};
/**
- * @return {@code true</tt> if and only if the specified <tt>event} is
+ * @return {@code true} if and only if the specified {@code event} is
* allowed to be offered to the event queue. The {@code event} is dropped
* if {@code false} is returned.
*
diff --git
a/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java
b/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java
index 772f7b892..a7b2524e4 100644
---
a/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java
+++
b/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java
@@ -84,7 +84,7 @@ import org.apache.mina.core.write.WriteRequest;
* <td>
* Both {@link KeepAliveMessageFactory#getRequest(IoSession)} and
* {@link KeepAliveMessageFactory#getResponse(IoSession, Object)} must
- * return a non-{@code null</tt>, and the <tt>timeoutHandler} property
+ * return a non-{@code null}, and the {@code timeoutHandler} property
* should be set to {@link KeepAliveRequestTimeoutHandler#NOOP},
* {@link KeepAliveRequestTimeoutHandler#LOG} or the custom {@link
KeepAliveRequestTimeoutHandler}
* implementation that doesn't affect the session state nor throw an
exception.
@@ -112,7 +112,7 @@ import org.apache.mina.core.write.WriteRequest;
* {@link KeepAliveMessageFactory#getRequest(IoSession)} must return
* a non-{@code null},
* {@link KeepAliveMessageFactory#getResponse(IoSession, Object)} must
- * return {@code null</tt> and the <tt>timeoutHandler} must be set to
+ * return {@code null} and the {@code timeoutHandler} must be set to
* {@link KeepAliveRequestTimeoutHandler#DEAF_SPEAKER}.
* </td>
* </tr>
diff --git
a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java
b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java
index 8cef40952..60657a33e 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java
@@ -211,7 +211,7 @@ public class SslContextFactory {
* return by {@link KeyManagerFactory#getDefaultAlgorithm()} will be used.
* The default value of this property is {@code true}.
*
- * @param useDefault {@code true</tt> or <tt>false}.
+ * @param useDefault {@code true} or {@code false}.
*/
public void setKeyManagerFactoryAlgorithmUseDefault(boolean useDefault) {
this.keyManagerFactoryAlgorithmUseDefault = useDefault;
@@ -225,7 +225,7 @@ public class SslContextFactory {
* return by {@link TrustManagerFactory#getDefaultAlgorithm()} will be
used.
* The default value of this property is {@code true}.
*
- * @param useDefault {@code true</tt> or <tt>false}.
+ * @param useDefault {@code true} or {@code false}.
*/
public void setTrustManagerFactoryAlgorithmUseDefault(boolean useDefault) {
this.trustManagerFactoryAlgorithmUseDefault = useDefault;
diff --git a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java
b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java
index b2758d257..dd58371af 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java
@@ -190,7 +190,7 @@ public class SslFilter extends IoFilterAdapter {
/**
* Creates a new SSL filter using the specified {@link SSLContext}.
- * If the {@code autostart</tt> flag is set to <tt>true}, the
+ * If the {@code autostart} flag is set to {@code true}, the
* handshake will start immediately after the filter has been added
* to the chain.
*
@@ -222,7 +222,7 @@ public class SslFilter extends IoFilterAdapter {
* you don't need to call this method unless you've used TLS closure.
*
* @param session The session that will be switched to SSL mode
- * @return {@code true</tt> if the SSL session has been started,
<tt>false} if already started.
+ * @return {@code true} if the SSL session has been started, {@code false}
if already started.
* @throws SSLException if failed to start the SSL session
*/
public boolean startSsl(IoSession session) throws SSLException {
@@ -286,9 +286,9 @@ public class SslFilter extends IoFilterAdapter {
}
/**
- * @return {@code true</tt> if and only if the specified <tt>session} is
+ * @return {@code true} if and only if the specified {@code session} is
* encrypted/decrypted over SSL/TLS currently. This method will start
- * to return {@code false</tt> after TLS <tt>close_notify} message
+ * to return {@code false} after TLS {@code close_notify} message
* is sent and any messages written after then is not going to get
encrypted.
*
* @param session the session we want to check
@@ -362,7 +362,7 @@ public class SslFilter extends IoFilterAdapter {
/**
* Configures the engine to use client (or server) mode when handshaking.
*
- * @param clientMode {@code true</tt> when we are in client mode,
<tt>false} when in server mode
+ * @param clientMode {@code true} when we are in client mode, {@code
false} when in server mode
*/
public void setUseClientMode(boolean clientMode) {
this.client = clientMode;
diff --git a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslHandler.java
b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslHandler.java
index 2745808e4..2366b50f4 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslHandler.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslHandler.java
@@ -469,7 +469,7 @@ class SslHandler {
/**
* Start SSL shutdown process.
*
- * @return {@code true</tt> if shutdown process is started. <tt>false} if
+ * @return {@code true} if shutdown process is started. {@code false} if
* shutdown process is already finished.
* @throws SSLException
* on errors
diff --git
a/mina-core/src/main/java/org/apache/mina/handler/demux/DemuxingIoHandler.java
b/mina-core/src/main/java/org/apache/mina/handler/demux/DemuxingIoHandler.java
index 89f7e85d0..3d64a1ae8 100644
---
a/mina-core/src/main/java/org/apache/mina/handler/demux/DemuxingIoHandler.java
+++
b/mina-core/src/main/java/org/apache/mina/handler/demux/DemuxingIoHandler.java
@@ -101,7 +101,7 @@ public class DemuxingIoHandler extends IoHandlerAdapter {
* @param type The message's type
* @param handler The message handler
* @return the old handler if there is already a registered handler for
- * the specified {@code type</tt>. <tt>null} otherwise.
+ * the specified {@code type}. {@code null} otherwise.
*/
@SuppressWarnings("unchecked")
public <E> MessageHandler<? super E> addReceivedMessageHandler(Class<E>
type, MessageHandler<? super E> handler) {
@@ -133,7 +133,7 @@ public class DemuxingIoHandler extends IoHandlerAdapter {
* @param type The message's type
* @param handler The message handler
* @return the old handler if there is already a registered handler for
- * the specified {@code type</tt>. <tt>null} otherwise.
+ * the specified {@code type}. {@code null} otherwise.
*/
@SuppressWarnings("unchecked")
public <E> MessageHandler<? super E> addSentMessageHandler(Class<E> type,
MessageHandler<? super E> handler) {
@@ -165,7 +165,7 @@ public class DemuxingIoHandler extends IoHandlerAdapter {
* @param type The message's type
* @param handler The Exception handler
* @return the old handler if there is already a registered handler for
- * the specified {@code type</tt>. <tt>null} otherwise.
+ * the specified {@code type}. {@code null} otherwise.
*/
@SuppressWarnings("unchecked")
public <E extends Throwable> ExceptionHandler<? super E>
addExceptionHandler(Class<E> type,
diff --git
a/mina-core/src/main/java/org/apache/mina/handler/demux/MessageHandler.java
b/mina-core/src/main/java/org/apache/mina/handler/demux/MessageHandler.java
index 139b7711b..e890c814b 100644
--- a/mina-core/src/main/java/org/apache/mina/handler/demux/MessageHandler.java
+++ b/mina-core/src/main/java/org/apache/mina/handler/demux/MessageHandler.java
@@ -23,7 +23,7 @@ import org.apache.mina.core.session.IoSession;
/**
* A handler interface that {@link DemuxingIoHandler} forwards
- * {@code messageReceived</tt> or <tt>messageSent} events to. You have to
+ * {@code messageReceived} or {@code messageSent} events to. You have to
* register your handler with the type of the message you want to get notified
* using {@link DemuxingIoHandler#addReceivedMessageHandler(Class,
MessageHandler)}
* or {@link DemuxingIoHandler#addSentMessageHandler(Class, MessageHandler)}.
diff --git
a/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java
b/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java
index 7b465051e..6db3c7523 100644
---
a/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java
+++
b/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractDatagramSessionConfig.java
@@ -79,7 +79,7 @@ public abstract class AbstractDatagramSessionConfig extends
AbstractIoSessionCon
}
/**
- * @return {@code true</tt> if and only if the <tt>broadcast} property
+ * @return {@code true} if and only if the {@code broadcast} property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
@@ -90,7 +90,7 @@ public abstract class AbstractDatagramSessionConfig extends
AbstractIoSessionCon
}
/**
- * @return {@code true</tt> if and only if the <tt>receiveBufferSize}
property
+ * @return {@code true} if and only if the {@code receiveBufferSize}
property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
@@ -101,7 +101,7 @@ public abstract class AbstractDatagramSessionConfig extends
AbstractIoSessionCon
}
/**
- * @return {@code true</tt> if and only if the <tt>reuseAddress} property
+ * @return {@code true} if and only if the {@code reuseAddress} property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
@@ -112,7 +112,7 @@ public abstract class AbstractDatagramSessionConfig extends
AbstractIoSessionCon
}
/**
- * @return {@code true</tt> if and only if the <tt>sendBufferSize} property
+ * @return {@code true} if and only if the {@code sendBufferSize} property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
@@ -123,7 +123,7 @@ public abstract class AbstractDatagramSessionConfig extends
AbstractIoSessionCon
}
/**
- * @return {@code true</tt> if and only if the <tt>trafficClass} property
+ * @return {@code true} if and only if the {@code trafficClass} property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
diff --git
a/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java
b/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java
index b87b979e2..1813e95bc 100644
---
a/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java
+++
b/mina-core/src/main/java/org/apache/mina/transport/socket/AbstractSocketSessionConfig.java
@@ -82,7 +82,7 @@ public abstract class AbstractSocketSessionConfig extends
AbstractIoSessionConfi
}
/**
- * @return {@code true</tt> if and only if the <tt>keepAlive} property
+ * @return {@code true} if and only if the {@code keepAlive} property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
@@ -93,7 +93,7 @@ public abstract class AbstractSocketSessionConfig extends
AbstractIoSessionConfi
}
/**
- * @return {@code true</tt> if and only if the <tt>oobInline} property
+ * @return {@code true} if and only if the {@code oobInline} property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
@@ -104,7 +104,7 @@ public abstract class AbstractSocketSessionConfig extends
AbstractIoSessionConfi
}
/**
- * @return {@code true</tt> if and only if the <tt>receiveBufferSize}
property
+ * @return {@code true} if and only if the {@code receiveBufferSize}
property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
@@ -115,7 +115,7 @@ public abstract class AbstractSocketSessionConfig extends
AbstractIoSessionConfi
}
/**
- * @return {@code true</tt> if and only if the <tt>reuseAddress} property
+ * @return {@code true} if and only if the {@code reuseAddress} property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
@@ -126,7 +126,7 @@ public abstract class AbstractSocketSessionConfig extends
AbstractIoSessionConfi
}
/**
- * @return {@code true</tt> if and only if the <tt>sendBufferSize} property
+ * @return {@code true} if and only if the {@code sendBufferSize} property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
@@ -137,7 +137,7 @@ public abstract class AbstractSocketSessionConfig extends
AbstractIoSessionConfi
}
/**
- * @return {@code true</tt> if and only if the <tt>soLinger} property
+ * @return {@code true} if and only if the {@code soLinger} property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
@@ -148,7 +148,7 @@ public abstract class AbstractSocketSessionConfig extends
AbstractIoSessionConfi
}
/**
- * @return {@code true</tt> if and only if the <tt>tcpNoDelay} property
+ * @return {@code true} if and only if the {@code tcpNoDelay} property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
@@ -159,7 +159,7 @@ public abstract class AbstractSocketSessionConfig extends
AbstractIoSessionConfi
}
/**
- * @return {@code true</tt> if and only if the <tt>trafficClass} property
+ * @return {@code true} if and only if the {@code trafficClass} property
* has been changed by its setter method. The system call related with
* the property is made only when this method returns {@code true}. By
* default, this method always returns {@code true} to simplify
implementation
diff --git
a/mina-core/src/main/java/org/apache/mina/transport/socket/SocketAcceptor.java
b/mina-core/src/main/java/org/apache/mina/transport/socket/SocketAcceptor.java
index 9f976c0cc..07422c121 100644
---
a/mina-core/src/main/java/org/apache/mina/transport/socket/SocketAcceptor.java
+++
b/mina-core/src/main/java/org/apache/mina/transport/socket/SocketAcceptor.java
@@ -61,7 +61,7 @@ public interface SocketAcceptor extends IoAcceptor {
/**
* @see ServerSocket#getReuseAddress()
*
- * @return {@code true</tt> if the <tt>SO_REUSEADDR} is enabled
+ * @return {@code true} if the {@code SO_REUSEADDR} is enabled
*/
boolean isReuseAddress();
diff --git
a/mina-core/src/main/java/org/apache/mina/transport/socket/SocketSessionConfig.java
b/mina-core/src/main/java/org/apache/mina/transport/socket/SocketSessionConfig.java
index bdcc0284f..92fe15fcc 100644
---
a/mina-core/src/main/java/org/apache/mina/transport/socket/SocketSessionConfig.java
+++
b/mina-core/src/main/java/org/apache/mina/transport/socket/SocketSessionConfig.java
@@ -82,14 +82,14 @@ public interface SocketSessionConfig extends
IoSessionConfig {
* @see Socket#setTrafficClass(int)
*
* @param trafficClass The traffic class to set, one of {@code
IPTOS_LOWCOST} (0x02)
- * {@code IPTOS_RELIABILITY</tt> (0x04), <tt>IPTOS_THROUGHPUT</tt> (0x08)
or <tt>IPTOS_LOWDELAY} (0x10)
+ * {@code IPTOS_RELIABILITY} (0x04), {@code IPTOS_THROUGHPUT} (0x08) or
{@code IPTOS_LOWDELAY} (0x10)
*/
void setTrafficClass(int trafficClass);
/**
* @see Socket#getKeepAlive()
*
- * @return {@code true</tt> if <tt>SO_KEEPALIVE} is enabled.
+ * @return {@code true} if {@code SO_KEEPALIVE} is enabled.
*/
boolean isKeepAlive();
@@ -103,7 +103,7 @@ public interface SocketSessionConfig extends
IoSessionConfig {
/**
* @see Socket#getOOBInline()
*
- * @return {@code true</tt> if <tt>SO_OOBINLINE} is enabled.
+ * @return {@code true} if {@code SO_OOBINLINE} is enabled.
*/
boolean isOobInline();
@@ -139,14 +139,14 @@ public interface SocketSessionConfig extends
IoSessionConfig {
/**
* @see Socket#getTcpNoDelay()
*
- * @return {@code true</tt> if <tt>TCP_NODELAY} is enabled.
+ * @return {@code true} if {@code TCP_NODELAY} is enabled.
*/
boolean isTcpNoDelay();
/**
* @see Socket#setTcpNoDelay(boolean)
*
- * @param tcpNoDelay {@code true</tt> if <tt>TCP_NODELAY} is to be enabled
+ * @param tcpNoDelay {@code true} if {@code TCP_NODELAY} is to be enabled
*/
void setTcpNoDelay(boolean tcpNoDelay);
}
diff --git
a/mina-core/src/main/java/org/apache/mina/util/byteaccess/CompositeByteArrayRelativeBase.java
b/mina-core/src/main/java/org/apache/mina/util/byteaccess/CompositeByteArrayRelativeBase.java
index 634984ffe..23edeaf64 100644
---
a/mina-core/src/main/java/org/apache/mina/util/byteaccess/CompositeByteArrayRelativeBase.java
+++
b/mina-core/src/main/java/org/apache/mina/util/byteaccess/CompositeByteArrayRelativeBase.java
@@ -99,7 +99,7 @@ abstract class CompositeByteArrayRelativeBase {
}
/**
- * @return <TT>TRUE</TT> if there are some more bytes
+ * @return {@code TRUE} if there are some more bytes
*/
public final boolean hasRemaining() {
return cursor.hasRemaining();
diff --git
a/mina-filter-compression/src/main/java/org/apache/mina/filter/compression/Zlib.java
b/mina-filter-compression/src/main/java/org/apache/mina/filter/compression/Zlib.java
index 9e5c2deba..130aa2ebe 100644
---
a/mina-filter-compression/src/main/java/org/apache/mina/filter/compression/Zlib.java
+++
b/mina-filter-compression/src/main/java/org/apache/mina/filter/compression/Zlib.java
@@ -29,7 +29,7 @@ import com.jcraft.jzlib.ZStream;
/**
* A helper class for interfacing with the JZlib library. This class acts both
* as a compressor and decompressor, but only as one at a time. The only
- * flush method supported is {@code Z_SYNC_FLUSH</tt> also known as
<tt>Z_PARTIAL_FLUSH}
+ * flush method supported is {@code Z_SYNC_FLUSH} also known as {@code
Z_PARTIAL_FLUSH}
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
@@ -65,10 +65,10 @@ class Zlib {
* Creates an instance of the ZLib class.
*
* @param compressionLevel the level of compression that should be used.
One of
- * {@code COMPRESSION_MAX</tt>, <tt>COMPRESSION_MIN},
- * {@code COMPRESSION_NONE</tt> or <tt>COMPRESSION_DEFAULT}
+ * {@code COMPRESSION_MAX}, {@code COMPRESSION_MIN},
+ * {@code COMPRESSION_NONE} or {@code COMPRESSION_DEFAULT}
* @param mode the mode in which the instance will operate. Can be either
- * of {@code MODE_DEFLATER</tt> or <tt>MODE_INFLATER}
+ * of {@code MODE_DEFLATER} or {@code MODE_INFLATER}
* @throws IllegalArgumentException if the mode is incorrect
*/
public Zlib(int compressionLevel, int mode) {
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 42cf1b13d..83573ceae 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
@@ -86,7 +86,7 @@ public abstract class AbstractStateContextLookup implements
StateContextLookup {
* {@link StateContext} objects.
*
* @param c the class.
- * @return {@code true</tt> or <tt>false}.
+ * @return {@code true} or {@code false}.
*/
protected abstract boolean supports(Class<?> c);
}
diff --git
a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/SelfTransition.java
b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/SelfTransition.java
index 68c16633a..b1d14bea5 100644
---
a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/SelfTransition.java
+++
b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/SelfTransition.java
@@ -34,7 +34,7 @@ public interface SelfTransition {
*
* @param stateContext The context in which we are executing the transition
* @param state The current state
- * @return {@code true</tt> if the execution succeeded, <tt>false}
otherwise.
+ * @return {@code true} if the execution succeeded, {@code false}
otherwise.
*/
boolean execute(StateContext stateContext, State state);
}
