Fixed some javadoc

Author: Emmanuel Lécharny

mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilter.java

@@ -42,7 +42,7 @@
  * {@link IoSession}s.</strong> Users can cache the reference to the
  * session, which might malfunction if any filters are added or removed later.
  *
- * <h3>The Life Cycle</h3>
+ * <h2>The Life Cycle</h2>
  * {@link IoFilter}s are activated only when they are inside {@link IoFilterChain}.
  * <p>
  * When you add an {@link IoFilter} to an {@link IoFilterChain}:

mina-core/src/main/java/org/apache/mina/core/future/CloseFuture.java

@@ -22,7 +22,7 @@
 /**
  * An {@link IoFuture} for asynchronous close requests.
  *
- * <h3>Example</h3>
+ * <h2>Example</h2>
  * <pre>
  * IoSession session = ...;
  * CloseFuture future = session.close(true);

mina-core/src/main/java/org/apache/mina/core/future/ConnectFuture.java

@@ -24,7 +24,7 @@
 /**
  * An {@link IoFuture} for asynchronous connect requests.
  *
- * <h3>Example</h3>
+ * <h2>Example</h2>
  * <pre>
  * IoConnector connector = ...;
  * ConnectFuture future = connector.connect(...);

mina-core/src/main/java/org/apache/mina/core/future/ReadFuture.java

@@ -24,7 +24,7 @@
 /**
  * An {@link IoFuture} for {@link IoSession#read() asynchronous read requests}. 
  *
- * <h3>Example</h3>
+ * <h2>Example</h2>
  * <pre>
  * IoSession session = ...;
  * 

mina-core/src/main/java/org/apache/mina/core/future/WriteFuture.java

@@ -22,7 +22,7 @@
 /**
  * An {@link IoFuture} for asynchronous write requests.
  *
- * <h3>Example</h3>
+ * <h2>Example</h2>
  * <pre>
  * IoSession session = ...;
  * WriteFuture future = session.write(...);

mina-core/src/main/java/org/apache/mina/core/session/IoSession.java

@@ -46,19 +46,19 @@
  *   It often contains objects that represents the state of a higher-level protocol
  *   and becomes a way to exchange data between filters and handlers.
  * </p>
- * <h3>Adjusting Transport Type Specific Properties</h3>
+ * <h2>Adjusting Transport Type Specific Properties</h2>
  * <p>
  *   You can simply downcast the session to an appropriate subclass.
  * </p>
- * <h3>Thread Safety</h3>
+ * <h2>Thread Safety</h2>
  * <p>
  *   {@link IoSession} is thread-safe.  But please note that performing
  *   more than one {@link #write(Object)} calls at the same time will
  *   cause the {@link IoFilter#filterWrite(IoFilter.NextFilter,IoSession,WriteRequest)}
  *   to be executed simultaneously, and therefore you have to make sure the
  *   {@link IoFilter} implementations you're using are thread-safe, too.
  * </p>
- * <h3>Equality of Sessions</h3>
+ * <h2>Equality of Sessions</h2>
  * TODO : The getId() method is totally wrong. We can't base
  * a method which is designed to create a unique ID on the hashCode method.
  * {@link Object#equals(Object)} and {@link Object#hashCode()} shall not be overriden

mina-core/src/main/java/org/apache/mina/core/session/IoSessionConfig.java

@@ -27,8 +27,9 @@
  * @author <a href="http://mina.apache.org">Apache MINA Project</a>
  */
 public interface IoSessionConfig {
-
     /**
+     * Get the read buffer size
+     * 
      * @return the size of the read buffer that I/O processor allocates
      * per each read.  It's unusual to adjust this property because
      * it's often adjusted automatically by the I/O processor.
@@ -45,6 +46,8 @@ public interface IoSessionConfig {
     void setReadBufferSize(int readBufferSize);
 
     /**
+     * Get the minimum size of the read buffer
+     * 
      * @return the minimum size of the read buffer that I/O processor
      * allocates per each read.  I/O processor will not decrease the
      * read buffer size to the smaller value than this property value.
@@ -61,6 +64,8 @@ public interface IoSessionConfig {
     void setMinReadBufferSize(int minReadBufferSize);
 
     /**
+     * Get the maximum size of the read buffer
+     * 
      * @return the maximum size of the read buffer that I/O processor
      * allocates per each read.  I/O processor will not increase the
      * read buffer size to the greater value than this property value.
@@ -77,12 +82,16 @@ public interface IoSessionConfig {
     void setMaxReadBufferSize(int maxReadBufferSize);
 
     /**
+     * Get the throughput interval
+     * 
      * @return the interval (seconds) between each throughput calculation.
      * The default value is <code>3</code> seconds.
      */
     int getThroughputCalculationInterval();
 
     /**
+     * Get the throughput interval in milliseconds
+     * 
      * @return the interval (milliseconds) between each throughput calculation.
      * The default value is <code>3</code> seconds.
      */
@@ -97,6 +106,8 @@ public interface IoSessionConfig {
     void setThroughputCalculationInterval(int throughputCalculationInterval);
 
     /**
+     * Get the idle time
+     * 
      * @return idle time for the specified type of idleness in seconds.
      * 
      * @param status The status for which we want the idle time (One of READER_IDLE,
@@ -105,6 +116,8 @@ public interface IoSessionConfig {
     int getIdleTime(IdleStatus status);
 
     /**
+     * Get the idle time in milliseconds
+     * 
      * @return idle time for the specified type of idleness in milliseconds.
      * 
      * @param status The status for which we want the idle time (One of READER_IDLE,
@@ -121,11 +134,15 @@ public interface IoSessionConfig {
     void setIdleTime(IdleStatus status, int idleTime);
 
     /**
+     * Get the read idle time
+     * 
      * @return idle time for {@link IdleStatus#READER_IDLE} in seconds.
      */
     int getReaderIdleTime();
 
     /**
+     * Get the read idle time in milliseconds
+     * 
      * @return idle time for {@link IdleStatus#READER_IDLE} in milliseconds.
      */
     long getReaderIdleTimeInMillis();
@@ -138,11 +155,15 @@ public interface IoSessionConfig {
     void setReaderIdleTime(int idleTime);
 
     /**
+     * Get the write idle time
+     * 
      * @return idle time for {@link IdleStatus#WRITER_IDLE} in seconds.
      */
     int getWriterIdleTime();
 
     /**
+     * Get the write idle time in milliseconds
+     * 
      * @return idle time for {@link IdleStatus#WRITER_IDLE} in milliseconds.
      */
     long getWriterIdleTimeInMillis();
@@ -155,11 +176,15 @@ public interface IoSessionConfig {
     void setWriterIdleTime(int idleTime);
 
     /**
+     * Get the idle time for reads and writes
+     * 
      * @return idle time for {@link IdleStatus#BOTH_IDLE} in seconds.
      */
     int getBothIdleTime();
 
     /**
+     * Get the idle time in milliseconds
+     * 
      * @return idle time for {@link IdleStatus#BOTH_IDLE} in milliseconds.
      */
     long getBothIdleTimeInMillis();
@@ -172,11 +197,15 @@ public interface IoSessionConfig {
     void setBothIdleTime(int idleTime);
 
     /**
+     * Get the write timeout in seconds.
+     * 
      * @return write timeout in seconds.
      */
     int getWriteTimeout();
 
     /**
+     * Get the write timeout in milliseconds.
+     * 
      * @return write timeout in milliseconds.
      */
     long getWriteTimeoutInMillis();
@@ -189,6 +218,8 @@ public interface IoSessionConfig {
     void setWriteTimeout(int writeTimeout);
 
     /**
+     * Tell if the read operation is enabled
+     * 
      * @return <code>true</code> if and only if {@link IoSession#read()} operation
      * is enabled.  If enabled, all received messages are stored in an internal
      * {@link BlockingQueue} so you can read received messages in more

mina-core/src/main/java/org/apache/mina/filter/executor/WriteRequestFilter.java

@@ -46,7 +46,7 @@
  *             new WriteRequestFilter(new IoEventQueueThrottle()));
  * </pre>
  *
- * <h3>Known issues</h3>
+ * <h2>Known issues</h2>
  *
  * You can run into a dead lock if you run this filter with the blocking
  * {@link IoEventQueueHandler} implementation such as {@link IoEventQueueThrottle}

mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java

@@ -60,7 +60,7 @@
  *   <tr>
  *     <th>Name</th><th>Description</th><th>Implementation</th>
  *   </tr>
- *   <tr valign="top">
+ *   <tr>
  *     <td>Active</td>
  *     <td>
  *       You want a keep-alive request is sent when the reader is idle.
@@ -75,7 +75,7 @@
  *       return a non-<code>null</code>.
  *     </td>
  *   </tr>
- *   <tr valign="top">
+ *   <tr>
  *     <td>Semi-active</td>
  *     <td>
  *       You want a keep-alive request to be sent when the reader is idle.
@@ -92,7 +92,7 @@
  *       implementation that doesn't affect the session state nor throw an exception.
  *     </td>
  *   </tr>
- *   <tr valign="top">
+ *   <tr>
  *     <td>Passive</td>
  *     <td>
  *       You don't want to send a keep-alive request by yourself, but the
@@ -104,7 +104,7 @@
  *       must return a non-<code>null</code>.
  *     </td>
  *   </tr>
- *   <tr valign="top">
+ *   <tr>
  *     <td>Deaf Speaker</td>
  *     <td>
  *       You want a keep-alive request to be sent when the reader is idle, but
@@ -118,7 +118,7 @@
  *       {@link KeepAliveRequestTimeoutHandler#DEAF_SPEAKER}.
  *     </td>
  *   </tr>
- *   <tr valign="top">
+ *   <tr>
  *     <td>Silent Listener</td>
  *     <td>
  *       You don't want to send a keep-alive request by yourself nor send any

mina-core/src/main/java/org/apache/mina/transport/socket/DatagramSessionConfig.java

@@ -31,6 +31,8 @@
  */
 public interface DatagramSessionConfig extends IoSessionConfig {
     /**
+     * Tell if SO_BROADCAST is enabled
+     * 
      * @see DatagramSocket#getBroadcast()
      * 
      * @return <code>true</code> if SO_BROADCAST is enabled.
@@ -45,6 +47,8 @@ public interface DatagramSessionConfig extends IoSessionConfig {
     void setBroadcast(boolean broadcast);
 
     /**
+     * Tells if SO_REUSEADDR is enabled
+     * 
      * @see DatagramSocket#getReuseAddress()
      * 
      * @return <code>true</code> if SO_REUSEADDR is enabled.
@@ -59,6 +63,8 @@ public interface DatagramSessionConfig extends IoSessionConfig {
     void setReuseAddress(boolean reuseAddress);
 
     /**
+     * Get the size of the receive buffer
+     * 
      * @see DatagramSocket#getReceiveBufferSize()
      * 
      * @return the size of the receive buffer
@@ -73,6 +79,8 @@ public interface DatagramSessionConfig extends IoSessionConfig {
     void setReceiveBufferSize(int receiveBufferSize);
 
     /**
+     * Get the size of the send buffer
+     *
      * @see DatagramSocket#getSendBufferSize()
      * 
      * @return the size of the send buffer
@@ -87,6 +95,8 @@ public interface DatagramSessionConfig extends IoSessionConfig {
     void setSendBufferSize(int sendBufferSize);
 
     /**
+     * Get the traffic class
+     * 
      * @see DatagramSocket#getTrafficClass()
      * 
      * @return the traffic class
@@ -102,6 +112,8 @@ public interface DatagramSessionConfig extends IoSessionConfig {
     void setTrafficClass(int trafficClass);
 
     /**
+     * Tells if we should close if the port is unreachable
+     * 
      * If method returns true, it means session should be closed when a
      * {@link PortUnreachableException} occurs.
      *